MyFavMirrors/RSSPAPER
1
0
Fork 0
mirror of https://github.com/tanrax/RSSPAPER.git synced 2025-02-06 19:28:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andros Fenollosa 2021-07-20 00:24:32 +02:00 committed by GitHub
parent 4cf00211e6
commit 8a91919427
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -2,29 +2,12 @@
<img alt="RSSpaper logo" src="resources/static/img/icons/default-alpha.png">
</h1>
<p align="center">
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
</p>
<p align="center">
(My own feed generated daily with Github Actions)
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a> (My own feed generated daily with Github Actions)
</p>
## 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.
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.
``` yaml
title: RSSPaper
@ -40,12 +23,12 @@ feeds:
- 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
4) Now you can execute.
3) Now you can execute.
```sh
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 📰.
That's it, now you just have to open `dist/index.html`.
## Testing
``` sh
lein check-idiomatic
lein check-format
```