mirror of
https://github.com/tanrax/RSSingle.git
synced 2025-03-03 03:35:46 +01:00
Formatted documentation
This commit is contained in:
@@ -1,15 +1,25 @@
|
||||
## Development
|
||||
|
||||
### Compiling
|
||||
# Development
|
||||
|
||||
<br>
|
||||
|
||||
## Compiling
|
||||
|
||||
*Commands are run from within the `/Source/` folder.*
|
||||
|
||||
<br>
|
||||
|
||||
```shell
|
||||
pyinstaller --onefile rssingle.py
|
||||
```
|
||||
<br>
|
||||
|
||||
Old versions
|
||||
### 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`.
|
||||
You will find the binary in `/dist/`.
|
||||
|
||||
<br>
|
@@ -1,45 +1,61 @@
|
||||
## Run
|
||||
|
||||
# Usage
|
||||
|
||||
1. Download the binary.
|
||||
|
||||
**Linux**
|
||||
### Linux
|
||||
|
||||
``` shell
|
||||
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle
|
||||
```
|
||||
``` shell
|
||||
wget https://github.com/tanrax/RSSingle/releases/download/v1.0.0/rssingle
|
||||
```
|
||||
|
||||
**MacOS and Windows**
|
||||
<br>
|
||||
|
||||
Coming soon
|
||||
### MacOS / Windows
|
||||
|
||||
*Coming soon*
|
||||
|
||||
<br>
|
||||
|
||||
2. Gives execution permissions.
|
||||
|
||||
``` shell
|
||||
chmod +x rssingle
|
||||
```
|
||||
``` shell
|
||||
chmod +x rssingle
|
||||
```
|
||||
|
||||
3. In the same directory as the binary, you can create a local `config.yml` file in this format:
|
||||
<br>
|
||||
|
||||
``` 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/
|
||||
```
|
||||
3. In the same directory as the binary, you can <br>
|
||||
create a local `config.yml` file in this format:
|
||||
|
||||
If not, you can download the example in the repository.
|
||||
``` 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/
|
||||
```
|
||||
|
||||
``` shell
|
||||
curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
|
||||
```
|
||||
If not, you can download the **[Example]** in the repository.
|
||||
|
||||
``` shell
|
||||
curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
4. Run the binary.
|
||||
|
||||
``` shell
|
||||
./rssingle
|
||||
```
|
||||
``` shell
|
||||
./rssingle
|
||||
```
|
||||
|
||||
A file called `rss.xml` will be created.
|
||||
A file called `rss.xml` will be created.
|
||||
|
||||
<br>
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Example]: ../Source/config.yml
|
Reference in New Issue
Block a user