mirror of
https://github.com/tanrax/RSSPAPER.git
synced 2025-05-22 10:01:51 -04:00
Update README.md
This commit is contained in:
parent
aa64f3baf7
commit
eaeb3b0415
45
README.md
45
README.md
@ -5,12 +5,53 @@
|
|||||||
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
|
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Usage
|
## Run
|
||||||
|
|
||||||
|
1) Make sure you have Java installed.
|
||||||
|
|
||||||
|
Debian/Ubuntu
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
sudo apt install default-jre
|
||||||
|
```
|
||||||
|
|
||||||
|
Mac OS
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
brew install java
|
||||||
|
```
|
||||||
|
|
||||||
|
2) Create a file `config.yaml` with the following content. You can also use `config.yaml.example` as a base config and change it to fit your needs.
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
title: RSSPaper
|
||||||
|
|
||||||
|
# Options: light or dark
|
||||||
|
theme: light
|
||||||
|
|
||||||
|
# Options: daily, weekly or all
|
||||||
|
edition: weekly
|
||||||
|
|
||||||
|
feeds:
|
||||||
|
- https://programadorwebvalencia.com/feed/
|
||||||
|
- https://republicaweb.es/feed/
|
||||||
|
```
|
||||||
|
|
||||||
|
3) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
|
||||||
|
|
||||||
|
https://github.com/tanrax/RSSpaper/releases
|
||||||
|
|
||||||
|
|
||||||
|
4) Now you can execute glosa.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
lein run
|
java -jar rsspaper-{version}-standalone.jar
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Great 🎉. You already have your 🔥 own Static RSS Newspaper 🔥.
|
||||||
|
|
||||||
|
That's it, now you just have to open `dist/index.html`.
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
|
Loading…
x
Reference in New Issue
Block a user