diff --git a/hacking.md b/hacking.md new file mode 100644 index 0000000..e3e307f --- /dev/null +++ b/hacking.md @@ -0,0 +1,43 @@ +# hacking + +If you have any questions/suggestions/proposals, +you can reach out the author via e-mail (nkanaev@live.com) +or mastodon (https://fosstodon.org/@nkanaev). + +## 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: + +``` +# 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 +``` + +## plans + +- test across 3 platforms (macos, linux, windows) +- prebuilt binaries +- GUI-less mode (no tray icon) +- feeds health checker +- mobile & tablet layout +- parameters (`--[no]-gui`, `--addr`, ...) +- Fever API support +- keyboard navigation + +## code of conduct + +Be excellent to each other. Party on, dudes! diff --git a/readme.md b/readme.md index 614275c..6e15866 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# yarr (beta) +# yarr yet another rss reader. @@ -12,32 +12,8 @@ Longer-term plans include a self-hosted solution for individuals. There are plans to add support for mobile & tablet resolutions. Support for 3rd-party applications (via Fever API) is being considered. -## build - -Install `Go >= 1.14` and `gcc`, then run: - -```sh -git clone https://github.com/nkanaev/yarr.git -git clone https://github.com/nkanaev/gofeed.git -mv gofeed yarr -cd yarr && make build_macos -``` - -## plans - -- test across 3 platforms (macos, linux, windows) -- prebuilt binaries -- GUI-less mode (no tray icon) -- feeds health checker -- mobile & tablet layout -- parameters (`--[no]-gui`, `--addr`, ...) -- Fever API support -- keyboard navigation +[download](https://github.com/nkanaev/yarr/releases/latest) ## credits [Feather](http://feathericons.com/) for icons. - -## code of conduct - -Be excellent to each other. Party on, dudes!