diff options
| author | Justin Worthe <justin@worthe-it.co.za> | 2017-08-02 21:06:44 +0200 |
|---|---|---|
| committer | Justin Worthe <justin@worthe-it.co.za> | 2017-08-02 21:06:44 +0200 |
| commit | 5f036a39e4781100e1e4ddc86c93e85ca16d0e7a (patch) | |
| tree | fea5824b52829fffe6a851f65d16d1d2fa9cece6 | |
| parent | d3edb4dd93b9dc81c7e7867b5142834cd438e437 (diff) | |
Made OSX travis build required and updated readme to reflect requirements
| -rw-r--r-- | .travis.yml | 1 | ||||
| -rw-r--r-- | README.org | 22 |
2 files changed, 22 insertions, 1 deletions
diff --git a/.travis.yml b/.travis.yml index 131f6f5..233190c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,6 @@ cache: cargo matrix: allow_failures: - rust: nightly - - os: osx addons: apt: @@ -15,10 +15,32 @@ day to day work. * Getting started +** Environment Setup + This is a Rust project. The latest version of the Rust compiler and Cargo are available from your system's package manager, or from https://www.rust-lang.org/. +The project depends on two native libraries: GTK and +Portaudio. These need to be preinstalled. + +On OSX, this can be done with Homebrew using + +#+BEGIN_SRC sh +brew install gtk+3 +brew install portaudio +#+END_SRC + +On Ubuntu, you can skip the portaudio install since it can be compiled +as part of the build process. You still need to install GTK though, +like so: + +#+BEGIN_SRC sh +apt-get install libgtk-3-bin libgtk-3-dev libpango1.0-0 +#+END_SRC + +** Compiling and running + To compile the project: #+BEGIN_SRC sh |