Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fluhus committed Feb 22, 2020
1 parent 0dfdbf6 commit 3857e88
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ With Beatnik you can type **text** which describes your beat, and Beatnik will i
2. Read the [tutorial](https://github.com/fluhus/beatnik/blob/master/TUTORIAL.md).
3. Start making beats using `btnk` with the command line, or `gui` with your browser.

### `btnk`
### btnk

`btnk` is a command line compiler that turns Beatnik code (typically with .btn suffix) into MIDI files.

Expand All @@ -24,16 +24,30 @@ btnk file1.btn file2.btn

`btnk` will create file1.btn.mid and file2.btn.mid.

### `gui`
### gui

`gui` is a graphical web interface. Once you run it you can open your browser at the address it shows on the terminal.

This is an experimental thing I did for demonstration purposes. Would love to get feedback on where to take it further!

## Getting The Code

To download the code and build your own:

1. Install the [go](https://golang.org/) compiler (add it to your path).
2. Set the GOPATH environment variable to you code directory.
3. Run:
```
go get github.com/fluhus/beatnik
go install github.com/fluhus/beatnik/btnk github.com/fluhus/beatnik/gui
```
4. Find the compiled binaries under `bin` and source code under `src`.

Happy coding!

## Samples

Isolated samples:

[Song 2](https://drive.google.com/file/d/1CVjNAYApnMNlhYOlAlGLJCB7WGvBDJO5/preview),
[50 Ways](https://drive.google.com/file/d/1qEw-5D6pLfflZBiCXrj60oeYwtHhJ1h_/preview)

Expand Down

0 comments on commit 3857e88

Please sign in to comment.