From 7011a1c776c35c4492c667a425586f92252145bf Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Fri, 2 Sep 2022 13:49:06 -0400 Subject: [PATCH] Updated the readme with install and uninstall info --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 177a1cd..c762a9a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # adept -Bit Goblin video transcoder service \ No newline at end of file +Bit Goblin video transcoder service + +## Installation + +**Note: currently Adept will only run on Linux as `lsof` is a runtime dependency, which doesn't have a Windows equivalent. This will be rectified in the future.** + +Build dependencies: +* go +* make + +Runtime dependencies: +* lsof + +To install dependencies on Ubuntu: `apt install golang make lsof` +To install dependencies on Red Hat/AlmaLinux: `dnf install go make lsof` + +To install Adept as a system service: `make build && sudo make install` + +## Uninstallation + +To uninstall Adept (if it was installed through make): `sudo make uninstall`