andros/RSSingle
1
0
Fork 0
mirror of https://github.com/tanrax/RSSingle.git synced 2025-03-03 03:35:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Formatted documentation

Browse Source
This commit is contained in:
ElectronicsArchiver
2022-06-25 14:29:52 -04:00
parent 910cc13626
commit 845b957523
3 changed files with 60 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/Development.md
View File

@@ -1,15 +1,25 @@
## Development
### Compiling # Development
<br>
## Compiling
*Commands are run from within the `/Source/` folder.*
<br>
```shell ```shell
pyinstaller --onefile rssingle.py pyinstaller --onefile rssingle.py
``` ```
<br>
Old versions ### Old Versions
```shell ```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" 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`. You will find the binary in `/dist/`.
<br>

72
Documentation/Usage.md
View File

@@ -1,45 +1,61 @@
## Run
# Usage
1. Download the binary. 1. Download the binary.
**Linux** ### Linux
``` shell ``` shell
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle
``` ```
<br>
**MacOS and Windows** ### MacOS / Windows
Coming soon *Coming soon*
<br>
2. Gives execution permissions. 2. Gives execution permissions.
``` shell ``` shell
chmod +x rssingle chmod +x rssingle
``` ```
<br>
3. In the same directory as the binary, you can create a local `config.yml` file in this format: 3. In the same directory as the binary, you can <br>
create a local `config.yml` file in this format:
``` yaml ``` yaml
title: My RSS Feed title: My RSS Feed
description: My customised RSS feed with technology news description: My customised RSS feed with technology news
url: https://www.example.com url: https://www.example.com
output: rss.xml output: rss.xml
feeds: feeds:
- https://programadorwebvalencia.com/feed/ - https://programadorwebvalencia.com/feed/
- https://republicaweb.es/feed/ - https://republicaweb.es/feed/
``` ```
If not, you can download the example in the repository. If not, you can download the **[Example]** in the repository.
``` shell ``` shell
curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
``` ```
<br>
4. Run the binary. 4. Run the binary.
``` shell ``` shell
./rssingle ./rssingle
``` ```
A file called `rss.xml` will be created. A file called `rss.xml` will be created.
<br>
<!----------------------------------------------------------------------------->
[Example]: ../Source/config.yml

2
README.md
View File

@@ -46,6 +46,8 @@
**[@shymega]** for his original project **[SingleRSS]**. **[@shymega]** for his original project **[SingleRSS]**.
<br>
<!-----------------------------------------------------------------------------> <!----------------------------------------------------------------------------->