Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates for portaudio and the --debug flag #278

Merged
merged 1 commit into from
Jul 3, 2023
Merged

README updates for portaudio and the --debug flag #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
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