diff --git a/README.md b/README.md new file mode 100644 index 0000000..0353d24 --- /dev/null +++ b/README.md @@ -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 . See source code for details.