diff --git a/README.md b/README.md index 972eea4..8f0a841 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ https://user-images.githubusercontent.com/51816057/144759799-b9eecf9e-93ad-43a7-a076-0ae47f03d03c.mp4 +## Table of Contents + +* [Roadmap](#roadmap) +* [Installing / Building](#installing--building) + * [AUR Package](#aur-package) + * [Manually](#manually) +* [Documentation](#documentation) + # Roadmap @@ -17,6 +25,23 @@ https://user-images.githubusercontent.com/51816057/144759799-b9eecf9e-93ad-43a7- - [x] Fuzzy Searching - [ ] Visual Mode (like vim) for updating playlists +# Installing / Building + +## AUR Package + +```bash +yay -S gomp-git +``` + +## Manually + +```bash +git clone https://github.com/aditya-K2/gomp && +cd gomp && +go build +``` + # Documentation The Documentation is hosted [here](https://aditya-K2.github.io/gomp/) + diff --git a/docs/index.md b/docs/index.md index 1d9f43e..999eb19 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +## Table Of Contents + * [Prerequisites](#prerequisites) * [Installing / Building](#installing--building) * [Configuration](#configuration) @@ -16,14 +18,6 @@ - Go Should Be Installed ( For Building ) - After Reading this it is highly recommended to read the [sample_config](https://github.com/aditya-K2/gomp/blob/master/sample_config.yml) -# Installing / Building - -```bash -git clone https://github.com/aditya-K2/gomp && -cd gomp && -go build -``` - # Configuration Configuration of gomp is done through a `config.yml` file in `$HOME/config/gomp/` diff --git a/extras/PKGBUILD b/extras/PKGBUILD new file mode 100644 index 0000000..8baa1b9 --- /dev/null +++ b/extras/PKGBUILD @@ -0,0 +1,21 @@ +# Maintainer: aditya-K2 +pkgname=gomp-git +pkgver=0.1 +pkgrel=1 +pkgdesc='MPD client inspired by ncmpcpp written in GO.' +arch=('any') +url="https://github.com/aditya-K2/gomp" +license=('GPL') +makedepends=('go') +source=("https://github.com/aditya-K2/gomp/archive/refs/heads/master.zip") +sha256sums=('SKIP') + +build() { + cd "${pkgname%-git}-master" + go build +} + +package() { + cd "${pkgname%-git}-master" + install -Dm 655 gomp -t "${pkgdir}/usr/bin" +}