Require libjack-dev on Linux

ideoforms · Oct 18, 2020 · f57f0ab · f57f0ab
1 parent 903b93a
commit f57f0ab
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,7 +11,7 @@ jobs:
       run: |
         sudo apt-get update -y
         sudo apt-get install python3 python3-setuptools python3-pip
-        sudo apt-get install libasound2-dev
+        sudo apt-get install libasound2-dev libjack-dev
         sudo pip3 install pytest
     - name: Python test
       run: python3 setup.py test
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -4,7 +4,13 @@
 
 isobar has been tested on Linux (Ubuntu, Raspberry Pi OS) and macOS. It has not been officially tested on Windows, although third-party contributions of support and QA efforts would be welcomed.
 
-It requires Python 3.5.    
+It requires Python 3.5 or above. 
+
+On Linux, the `libasound` and `libjack-dev` packages are also required:
+
+```
+apt install libasound2-dev libjack-dev
+```
 
 ### 1. Install isobar
 
@@ -56,4 +62,4 @@ The script will print the default MIDI driver to screen, and begin triggering no
 ## Next steps
 
 - [Code examples](https://github.com/ideoforms/isobar/tree/master/examples)
-- Read about [Patterns](patterns/index.md), [Timelines](timelines/index.md), [Events](events/index.md) and [Devices](devices/index.md),
+- Read about [Patterns](patterns/index.md), [Timelines](timelines/index.md), [Events](events/index.md) and [Devices](devices/index.md),