Updated the readme with install and uninstall info
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
Gregory Ballantine 2022-09-02 13:49:06 -04:00
parent a8a46df87f
commit 7011a1c776

View File

@ -1,3 +1,23 @@
# adept # adept
Bit Goblin video transcoder service 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`