diff --git a/Documentation/Development.md b/Documentation/Development.md new file mode 100644 index 0000000..f1a87c7 --- /dev/null +++ b/Documentation/Development.md @@ -0,0 +1,15 @@ +## Development + +### Compiling + +```shell +pyinstaller --onefile rssingle.py +``` + +Old versions + +```shell +docker run --rm --volume $PWD:/app python:3.8-buster /bin/bash -c "cd /app; pip3 install -r requirements.txt; pyinstaller --onefile rssingle.py" +``` + +You will find the binary in `dist`. \ No newline at end of file diff --git a/Documentation/Usage.md b/Documentation/Usage.md new file mode 100644 index 0000000..10360b4 --- /dev/null +++ b/Documentation/Usage.md @@ -0,0 +1,45 @@ +## Run + +1. Download the binary. + +**Linux** + +``` shell +wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle +``` + +**MacOS and Windows** + +Coming soon + +2. Gives execution permissions. + +``` shell +chmod +x rssingle +``` + +3. In the same directory as the binary, you can create a local `config.yml` file in this format: + +``` yaml +title: My RSS Feed +description: My customised RSS feed with technology news +url: https://www.example.com +output: rss.xml +feeds: + - https://programadorwebvalencia.com/feed/ + - https://republicaweb.es/feed/ +``` + +If not, you can download the example in the repository. + +``` shell +curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml +``` + +4. Run the binary. + +``` shell +./rssingle +``` + +A file called `rss.xml` will be created. \ No newline at end of file diff --git a/README.md b/README.md index 8f86d04..1783535 100644 --- a/README.md +++ b/README.md @@ -6,67 +6,9 @@ Generates an RSS file from the list of other feeds (RSS/Atom/JSON). Very handy w RRSingle

-## Run -1. Download the binary. -**Linux** -``` shell -wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle -``` - -**MacOS and Windows** - -Coming soon - -2. Gives execution permissions. - -``` shell -chmod +x rssingle -``` - -3. In the same directory as the binary, you can create a local `config.yml` file in this format: - -``` yaml -title: My RSS Feed -description: My customised RSS feed with technology news -url: https://www.example.com -output: rss.xml -feeds: - - https://programadorwebvalencia.com/feed/ - - https://republicaweb.es/feed/ -``` - -If not, you can download the example in the repository. - -``` shell -curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml -``` - -4. Run the binary. - -``` shell -./rssingle -``` - -A file called `rss.xml` will be created. - -## Development - -### Compiling - -```shell -pyinstaller --onefile rssingle.py -``` - -Old versions - -```shell -docker run --rm --volume $PWD:/app python:3.8-buster /bin/bash -c "cd /app; pip3 install -r requirements.txt; pyinstaller --onefile rssingle.py" -``` - -You will find the binary in `dist`. ## Thanks