Merge pull request #38 from razerbeans/documentation_updates

Updated README with ubuntu build dependencies
GuitarML · Jan 18, 2024 · 8cf9108 · 8cf9108
2 parents 9008b98 + 2cd8e25
commit 8cf9108
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+build/
+NeuralPi/
+*.deb
diff --git a/README.md b/README.md
@@ -110,6 +110,15 @@ To build the plugin for use on the Raspberry Pi with Elk Audio OS, see the offic
 
 ### Build with Cmake
 
+#### Dependencies
+##### Ubuntu 22.04
+The following packages will need to be installed on Ubuntu in order for build to succeed:
+```bash
+apt install cmake libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxft2-dev
+```
+
+#### Build
+
 ```bash
 # Clone the repository
 $ git clone https://github.com/GuitarML/NeuralPi.git