RSSPAPER/README.md

64 lines
1.1 KiB
Markdown
Raw Normal View History

2021-07-06 16:20:41 -04:00
<h1 align="center">
2021-07-18 18:06:12 -04:00
<img alt="RSSpaper logo" src="resources/static/img/icons/default-alpha.png">
2021-07-06 16:20:41 -04:00
</h1>
2021-07-06 12:02:59 -04:00
<p align="center">
<a href="https://rsspaper.andros.dev/">👉 DEMO 👈</a>
</p>
2021-07-06 16:29:09 -04:00
<p align="center">
(My own feed generated daily with Github Actions)
</p>
2020-11-03 17:57:47 -05:00
2021-07-06 16:26:44 -04:00
## 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
2021-07-06 19:07:59 -04:00
4) Now you can execute.
2020-11-03 17:57:47 -05:00
2020-11-04 01:25:21 -05:00
```sh
2021-07-06 16:26:44 -04:00
java -jar rsspaper-{version}-standalone.jar
2020-11-04 01:25:21 -05:00
```
2020-11-03 17:57:47 -05:00
2021-07-06 19:07:59 -04:00
Great 🎉. You already have your 📰 own Static RSS Newspaper 📰.
2021-07-06 16:26:44 -04:00
That's it, now you just have to open `dist/index.html`.
2020-11-04 01:25:21 -05:00
## Testing
2020-11-03 17:57:47 -05:00
2020-11-04 01:25:21 -05:00
``` sh
lein check-idiomatic
lein check-format
```