mirror of
https://github.com/nkanaev/yarr.git
synced 2025-09-13 09:55:36 +00:00
move hacking.md
This commit is contained in:
28
doc/hacking.md
Normal file
28
doc/hacking.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# hacking
|
||||
|
||||
## build
|
||||
|
||||
Install `Go >= 1.14` and `gcc`. Get the source code:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/nkanaev/yarr.git
|
||||
git clone https://github.com/nkanaev/gofeed.git
|
||||
mv gofeed yarr
|
||||
cd yarr
|
||||
```
|
||||
|
||||
Then:
|
||||
|
||||
```sh
|
||||
# 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 run locally (for testing & hacking)
|
||||
go run main.go # starts a server at http://localhost:7070
|
||||
```
|
||||
|
||||
## code of conduct
|
||||
|
||||
Be excellent to each other. Party on, dudes!
|
Reference in New Issue
Block a user