Skip to content
This repository has been archived by the owner on Jun 8, 2021. It is now read-only.

Commit

Permalink
public domain (The Unlicense)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanatkn committed May 12, 2021
1 parent 3f0d535 commit a77add4
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ your [relative pitch](https://en.wikipedia.org/wiki/Relative_pitch).

[https://ryanatkn.github.io/ear-sharpener](https://ryanatkn.github.io/ear-sharpener)

> note:
> [the piano sounds are **out of tune**](https://github.com/ryanatkn/ear-sharpener/issues/2),
> so don't play it too long
## Tech notes
- Made with TypeScript, React, Redux, Immutable.js, React Router, PostCSS, Mocha, Chai, Sinon,
Enzyme, Webpack, and the [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension).
- I wrote about my experience with TypeScript on this
game [here on Reddit](https://www.reddit.com/r/typescript/comments/4oa3gz/a_summary_of_my_experience_working_with/).
- Redux actions are type safe in reducers using the discriminated union types
available in the pre-2.0 TypeScript nightly.
The actions are defined in [`src/types.ts`](https://github.com/ryanatkn/ear-sharpener/blob/master/src/types.ts).
The actions are defined in [`src/types.ts`](https://github.com/ryanatkn/ear-sharpener/blob/main/src/types.ts).
The old ununsed hacky action implementation is in
[`src/utils/actions`](https://github.com/ryanatkn/ear-sharpener/blob/master/src/utils/actions/index.ts).
[`src/utils/actions`](https://github.com/ryanatkn/ear-sharpener/blob/main/src/utils/actions/index.ts).
- Friction between Redux and the needs of this game:
- There's a lot of complexity in the `gameActions` to get the desired UX.
The four main sources of complexity include time-sequenced actions and side effects,
Expand Down Expand Up @@ -82,4 +86,5 @@ at [freesound.org](https://www.freesound.org/search/?q=piano&f=grouping_pack%3A%
(public domain license) Transformed with Audacity into 3 second mp3s that fade out.

## License
MIT

public domain ([The Unlicense](license))
26 changes: 26 additions & 0 deletions license
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
The Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>
11 changes: 7 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
"name": "ear-sharpener",
"version": "0.1.0",
"description": "a simple game for practicing pitch perception",
"main": "index.js",
"license": "Unlicense",
"homepage": "https://github.org/ryanatkn/ear-sharpener#readme",
"author": {
"name": "Ryan Atkinson",
"email": "[email protected]",
"url": "https://www.ryanatkn.com"
},
"scripts": {
"start": "webpack-dev-server --progress --colors --inline",
"typecheck": "tsc --noEmit",
Expand All @@ -14,9 +20,6 @@
"type": "git",
"url": "git+ssh://[email protected]/ryanatkn/ear-sharpener.git"
},
"author": "Ryan Atkinson <[email protected]>",
"license": "MIT",
"homepage": "https://github.org/ryanatkn/ear-sharpener#readme",
"dependencies": {
"bluebird": "^3.4.0",
"immutable": "^3.7.6",
Expand Down

0 comments on commit a77add4

Please sign in to comment.