james/yarr
4
0
Fork 0
mirror of https://github.com/nkanaev/yarr.git synced 2025-05-24 00:33:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

move build instructions to readme

Browse Source
This commit is contained in:
Nazar Kanaev 2021-02-28 20:27:22 +00:00
parent a850d83b33
commit 2270f716f2
2 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/build.md
View File

@ -1,16 +0,0 @@
Install `Go >= 1.16` and `gcc`. Get the source code:
git clone --recurse-submodules https://github.com/nkanaev/yarr.git
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 .

19
readme.md
View File

@ -10,6 +10,25 @@ It is written in Go with the frontend in Vue.js. The storage is backed by SQLite
[download](https://github.com/nkanaev/yarr/releases/latest)
| [build](doc/build.md)
## build
Install `Go >= 1.16` and `gcc`. Get the source code:
git clone --recurse-submodules https://github.com/nkanaev/yarr.git
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 .
## credits
[Feather](http://feathericons.com/) for icons.