diff options
| author | panda-roux <contact@panda-roux.pub> | 2021-08-22 11:24:21 -0700 |
|---|---|---|
| committer | panda-roux <contact@panda-roux.pub> | 2021-08-22 11:24:21 -0700 |
| commit | 42c136e24d2b5676574ec0de231bb43aea41a0f6 (patch) | |
| tree | 2e55d110e0fff5e61d267df82921f677dd38d094 | |
| parent | 22728c0b6a8e30cc261036a678ea9565c6788c28 (diff) | |
added installation instructions
| -rw-r--r-- | README.md | 10 |
1 files changed, 9 insertions, 1 deletions
| @@ -4,9 +4,17 @@ An RSS-to-email aggregator tool. | |||
| 4 | 4 | ||
| 5 | The aim of this tool is to be simple to configure and run. | 5 | The aim of this tool is to be simple to configure and run. |
| 6 | 6 | ||
| 7 | ## Installation | ||
| 8 | ``` | ||
| 9 | git clone https://git.sr.ht/~panda-roux/rssmail | ||
| 10 | cd rssmail | ||
| 11 | cmake . && make | ||
| 12 | sudo make install | ||
| 13 | ``` | ||
| 14 | |||
| 7 | ## Usage | 15 | ## Usage |
| 8 | ``` | 16 | ``` |
| 9 | ./rssmail <first.conf> [second.conf ...] | 17 | rssmail <first.conf> [second.conf ...] |
| 10 | ``` | 18 | ``` |
| 11 | 19 | ||
| 12 | See example.conf for available configuration options and aliases. | 20 | See example.conf for available configuration options and aliases. |