diff --git a/.gitignore b/.gitignore index 75c107b..c05ac65 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ *.pro.user + +output/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..01a7b47 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Wallaread - SailfishOS client for Wallabag 2+ + +This project is a fork of the original [goestreicher repository](https://github.com/goestreicher/harbour-wallaread). In this repository is the continuation of that project . + +Wallaread is a client to SailfishOS for [Wallabag](https://www.wallabag.it/en), a self-hosted service that allows you to save a copy of your favorite articles to read later. + +## Installation + +The pre-compiled package is available through [OpenRepos](https://openrepos.net/content/kirbylife/wallabag). +You can install it by directly downloading the .rpm file for your architecture or through Storeman. + + +## Compilation + +The recomended option to compile this project + +```Bash +docker run --rm --privileged -v $PWD:/share coderus/sailfishos-platform-sdk:$OS_VERSION /bin/bash -c " mkdir -p build ; cd build ; cp -r /share/* . ; mb2 -t SailfishOS-4.5.0.16-aarch64 build ; sudo cp -r RPMS/*.rpm /share/output" +```