update docs

This commit is contained in:
Nazar Kanaev
2021-02-25 16:51:24 +00:00
parent 81df244d41
commit a3146926b1
8 changed files with 41 additions and 49 deletions

17
doc/build.md Normal file
View File

@@ -0,0 +1,17 @@
Install `Go >= 1.14` and `gcc`. Get the source code:
git clone https://github.com/nkanaev/yarr.git
git clone https://github.com/nkanaev/gofeed.git yarr/gofeed
Then run one of the corresponding commands:
# create a binary for the host os
make build_macos # -> _output/macos/yarr.app
make build_linux # -> _output/linux/yarr
make build_windows # -> _output/windows/yarr.exe
# ... or start a dev server locally
go run main.go # starts a server at http://localhost:7070
# ... or build a docker image
docker build -t yarr .