mirror of
https://github.com/tanrax/RSSingle.git
synced 2025-03-03 03:35:46 +01:00
Moved Section Into Dedicated Files
This commit is contained in:
15
Documentation/Development.md
Normal file
15
Documentation/Development.md
Normal file
@@ -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`.
|
45
Documentation/Usage.md
Normal file
45
Documentation/Usage.md
Normal file
@@ -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.
|
58
README.md
58
README.md
@@ -6,67 +6,9 @@ Generates an RSS file from the list of other feeds (RSS/Atom/JSON). Very handy w
|
|||||||
<img src="rssingle.png" width="200" alt="RRSingle">
|
<img src="rssingle.png" width="200" alt="RRSingle">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 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
|
## Thanks
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user