mirror of
https://github.com/tanrax/RSSPAPER.git
synced 2025-02-06 19:28:10 -05:00
Update README.md
This commit is contained in:
parent
4cf00211e6
commit
8a91919427
32
README.md
32
README.md
@ -2,29 +2,12 @@
|
|||||||
<img alt="RSSpaper logo" src="resources/static/img/icons/default-alpha.png">
|
<img alt="RSSpaper logo" src="resources/static/img/icons/default-alpha.png">
|
||||||
</h1>
|
</h1>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
|
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a> (My own feed generated daily with Github Actions)
|
||||||
</p>
|
|
||||||
<p align="center">
|
|
||||||
(My own feed generated daily with Github Actions)
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
1) Make sure you have Java installed.
|
1) 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.
|
||||||
|
|
||||||
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
|
``` yaml
|
||||||
title: RSSPaper
|
title: RSSPaper
|
||||||
@ -40,12 +23,12 @@ feeds:
|
|||||||
- https://republicaweb.es/feed/
|
- https://republicaweb.es/feed/
|
||||||
```
|
```
|
||||||
|
|
||||||
3) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
|
2) Download the latest version of RSSpaper (`rsspaper-{version}-standalone.jar`).
|
||||||
|
|
||||||
https://github.com/tanrax/RSSpaper/releases
|
https://github.com/tanrax/RSSpaper/releases
|
||||||
|
|
||||||
|
|
||||||
4) Now you can execute.
|
3) Now you can execute.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
java -jar rsspaper-{version}-standalone.jar
|
java -jar rsspaper-{version}-standalone.jar
|
||||||
@ -54,10 +37,3 @@ java -jar rsspaper-{version}-standalone.jar
|
|||||||
Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.
|
Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.
|
||||||
|
|
||||||
That's it, now you just have to open `dist/index.html`.
|
That's it, now you just have to open `dist/index.html`.
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
``` sh
|
|
||||||
lein check-idiomatic
|
|
||||||
lein check-format
|
|
||||||
```
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user