Program installation

.gitignore

@@ -1,5 +1,5 @@
 # ES-5-Pipewire
-es-5
+es-5-pipewire
 
 # ---> C
 # Prerequisites

Makefile

@@ -1,7 +1,7 @@
 CXX = gcc
 CXXFLAGS = -Wall
 LDLIBS =
-NAME = es-5
+NAME = es-5-pipewire
 LDLIBS += `pkg-config --cflags --libs libpipewire-0.3`
 
 es-5: es-5.c
@@ -13,7 +13,11 @@ clean:
 	rm ./$(NAME)
 
 run: all
-	./es-5
+	./$(NAME)
 
 debug: all
 	PIPEWIRE_DEBUG=5 ./$(NAME) 
+
+install: all
+	sudo mkdir -p /opt/$(NAME)
+	sudo cp ./$(NAME) /opt/$(NAME)/

README.md

@@ -1,3 +1,29 @@
 # ES-5-Pipewire
 
 A Pipewire client for the Expert Sleepers ES-5 eurorack module. Based upon [ES-5 Linx](https://github.com/CarlColglazier/ES-5Linx). This module takes eight gate inputs and converts them to a single output.
+
+## Setup
+
+### Requirements
+ - GCC
+ - Pipewire Development
+ 
+ #### Fedora & RHEL
+ ```sh
+ sudo dnf install gcc pipewire-devel
+ ```
+ #### Debian & Ubuntu
+ ```sh
+ sudo apt install gcc pipewire-dev
+ ```
+ 
+ ## Building
+ ```sh
+ make
+ ```
+ ### Installing
+ ```sh
+ make install
+ ```
+ 
+ This will build the binary and copy it over to the `/opt/es-5-pipewire` directory.