diff --git a/doc/build.md b/doc/build.md deleted file mode 100644 index f4bb73f..0000000 --- a/doc/build.md +++ /dev/null @@ -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 . diff --git a/readme.md b/readme.md index 6df88bc..d6c1ab0 100644 --- a/readme.md +++ b/readme.md @@ -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.