Added README.

This commit is contained in:
Emilis Dambauskas 2020-11-18 00:19:54 +02:00
parent 87b4fad366
commit 9be068a783
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# GMI Feed Aggregator
## Usage
### Prerequisites
* Python
### Running
Add feed URLs to _feeds.txt_.
Run `make` to create _index.gmi_.
Modify _header.gmi_ and _footer.gmi_ to customize the created page.
## License
Copyright 2020 Emilis Dambauskas emilis@emilis.net
This is free software, and you are welcome to redistribute it under certain conditions; see LICENSE.txt for details.
**gcat** is copyright Aaron Janse under a MIT-like license. Copied over from <https://github.com/aaronjanse/gcat>. See source code for details.