Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ashleymays committed Nov 28, 2023
1 parent 2d937f9 commit b4a66c4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ I've been working on this since July 2022. I generally use this as a sandbox to
Since I didn't know much about testing when I first started, there are no unit or integration tests available right now. I'll continue to work on that. This release will probably be the last, but please feel free to take the source code and do whatever you want with it (attribution would be nice, too :).

## How to Use
### Option 1: Open online with Stackblitz

<a href="https://stackblitz.com/~/github.com/ashleymays/piano-keyboard-simulator">https://stackblitz.com/~/github.com/ashleymays/piano-keyboard-simulator</a>

### Option 2: Install it locally

Clone the repository:

`git clone https://github.com/ashleymays/piano-keyboard-simulator.git`

Use the following command to run the build:
Run the build:

`npm i && npm start`

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b4a66c4

Please sign in to comment.