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 .

View File

@@ -1,28 +0,0 @@
# 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!

View File

@@ -1,15 +1,22 @@
# Linux desktop
The latest binary releases for MacOS/Windows/Linux are available
[here](https://github.com/nkanaev/yarr/releases/latest).
Grab the latest linux binary, then run:
## install (linux)
```
$ sudo mv /path/to/yarr /usr/local/bin
$ sudo tee /usr/local/share/applications/yarr.desktop >/dev/null <<EOF
[Desktop Entry]
Name=yarr
Exec=yarr -open
Icon=rss
Type=Application
Categories=Internet;
EOF
```
The Linux version doesn't come with the desktop environment integration.
For easy access you can manually create a desktop menu entry by
by following the steps below:
# get the latest linux binary zip
unzip -x yarr*.zip
sudo mv yarr /usr/local/bin/yarr
sudo nano /usr/local/share/applications/yarr.desktop
and paste the content below:
[Desktop Entry]
Name=yarr
Exec=/usr/loca/bin -open
Icon=rss
Type=Application
Categories=Internet;