From 5f036a39e4781100e1e4ddc86c93e85ca16d0e7a Mon Sep 17 00:00:00 2001
From: Justin Worthe <justin@worthe-it.co.za>
Date: Wed, 2 Aug 2017 21:06:44 +0200
Subject: Made OSX travis build required and updated readme to reflect
 requirements

---
 README.org | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 12c8177..bda0932 100644
--- a/README.org
+++ b/README.org
@@ -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
-- 
cgit v1.2.3