From 845b957523e930e1aaca211b7eee9cd7d58b89e1 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 25 Jun 2022 14:29:52 -0400
Subject: [PATCH] Formatted documentation
---
Documentation/Development.md | 18 +++++++--
Documentation/Usage.md | 72 ++++++++++++++++++++++--------------
README.md | 2 +
3 files changed, 60 insertions(+), 32 deletions(-)
diff --git a/Documentation/Development.md b/Documentation/Development.md
index f1a87c7..dcbd1f7 100644
--- a/Documentation/Development.md
+++ b/Documentation/Development.md
@@ -1,15 +1,25 @@
-## Development
-### Compiling
+# Development
+
+
+
+## Compiling
+
+*Commands are run from within the `/Source/` folder.*
+
+
```shell
pyinstaller --onefile rssingle.py
```
+
-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`.
\ No newline at end of file
+You will find the binary in `/dist/`.
+
+
\ No newline at end of file
diff --git a/Documentation/Usage.md b/Documentation/Usage.md
index 10360b4..d282240 100644
--- a/Documentation/Usage.md
+++ b/Documentation/Usage.md
@@ -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**
+ ### MacOS / Windows
-Coming soon
+ *Coming soon*
+
+
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:
+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/
-```
+ ``` 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.
+ If not, you can download the **[Example]** in the repository.
-``` shell
-curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
-```
+ ``` shell
+ curl -o config.yml https://raw.githubusercontent.com/tanrax/RSSingle/master/config.yml
+ ```
+
+
4. Run the binary.
-``` shell
-./rssingle
-```
+ ``` shell
+ ./rssingle
+ ```
-A file called `rss.xml` will be created.
\ No newline at end of file
+ A file called `rss.xml` will be created.
+
+
+
+
+
+[Example]: ../Source/config.yml
\ No newline at end of file
diff --git a/README.md b/README.md
index edeefae..b0abc64 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,8 @@
**[@shymega]** for his original project **[SingleRSS]**.
+
+