Skip to content

Commit

Permalink
Merge pull request #278 from scarpe-team/portaudio_readme_update
Browse files Browse the repository at this point in the history
README updates for portaudio and the --debug flag
  • Loading branch information
Schwad authored Jul 3, 2023
2 parents e7f8473 + c905730 commit 3e5e218
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,15 @@ Scarpe requires [Ruby 3.2](https://www.ruby-lang.org/en/downloads/) or higher! u
This is where most of the action is happening right now, and to have the full Scarpe experience _today_ this is probably what you want to do.

```
# dependencies - Mac version
brew install portaudio pkg-config # for sound!
# dependencies - Ubuntu Linux version
sudo apt-get install libportaudio2
# get it
git clone http://github.com/scarpe-team/scarpe
cd scarpe; bundle install
# run it
./exe/scarpe examples/button.rb --dev
```
Expand All @@ -69,6 +75,8 @@ Most commonly we are all using this command: `./exe/scarpe examples/button.rb --

The `--dev` flag points to your local scarpe rather than an installed Scarpe gem.

The `--debug` flag will dump a ton of useful information to the console if you want to see what's happening with your app.

It's very early in the development process. If you'd like to help develop Scarpe, great! It would be useful to drop us a message/issue/PR on GitHub early on, so we know you're working in a particular area, and we can warn you if anybody else is currently doing so.

We'd love the help!
Expand Down

0 comments on commit 3e5e218

Please sign in to comment.