]> gitweb.fluxo.info Git - httruta.git/commitdiff
Updates README
authorSilvio Rhatto <rhatto@riseup.net>
Sat, 25 Mar 2017 22:07:37 +0000 (19:07 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Sat, 25 Mar 2017 22:07:37 +0000 (19:07 -0300)
README.md

index f82d9f8f6e24ff022174634db0c7d63d60b4207e..6b28e6a0e9f1dc07fab1cc681c8043ed9d833406 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,27 @@ This is the engine behind the [Cache](https://cache.fluxo.info) feature used by
 the [Semantic Scuttle](http://semanticscuttle.sourceforge.net/) instance known
 as [Fluxo de Links](https://links.fluxo.info).
 
+Installation
+------------
+
+    git clone https://git.fluxo.info/httruta
+
+Dependencies
+------------
+
+Recommended:
+
+    sudo apt install httrack wkhtmltopdf
+
+Configuration
+-------------
+
+The default config is optimized for getting all new stuff added into [Fluxo de
+Links](https://links.fluxo.info).
+
+You might use httruta to archive any other website that has RSS support. To customize httruta,
+just copy the file `config.default` into `config` and edit to suit your needs.
+
 Usage
 -----