aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpanda-roux <contact@panda-roux.pub>2021-08-22 11:24:21 -0700
committerpanda-roux <contact@panda-roux.pub>2021-08-22 11:24:21 -0700
commit42c136e24d2b5676574ec0de231bb43aea41a0f6 (patch)
tree2e55d110e0fff5e61d267df82921f677dd38d094 /README.md
parent22728c0b6a8e30cc261036a678ea9565c6788c28 (diff)
added installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 453eeed..f63ce48 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,17 @@ An RSS-to-email aggregator tool.
4 4
5The aim of this tool is to be simple to configure and run. 5The aim of this tool is to be simple to configure and run.
6 6
7## Installation
8```
9git clone https://git.sr.ht/~panda-roux/rssmail
10cd rssmail
11cmake . && make
12sudo make install
13```
14
7## Usage 15## Usage
8``` 16```
9./rssmail <first.conf> [second.conf ...] 17rssmail <first.conf> [second.conf ...]
10``` 18```
11 19
12See example.conf for available configuration options and aliases. 20See example.conf for available configuration options and aliases.