summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 83f6cd5..189a442 100644
--- a/README.md
+++ b/README.md
@@ -12,24 +12,28 @@
- Works on BSD systems (such as MacOS and OpenBSD)
-- Only depends on `markdown`/`hoedown`
+- Depends on pandoc
- Less than 100 SLOC
### How to use
-First, install `markdown` or `hoedown` because this script uses it heavily.
+First, install `markdown`/`hoedown` because this script uses it heavily.
Put your markdown files on `articles/<name of file>.md` (create the directory if it doesn't exist).
-You also need to create a config file. Put it in `articles/<name of file>.cfg`. It should use the same name your markdown file uses.
-
-Example :
+You also need to create a config file. Put it in `articles/<name of file>.cfg`. It should use the same name your markdown file uses:
name="Hello World"
desc="Welcome to my blog!"
date="9th December 2021"
+You can create RSS feeds too, just modify the `rss.cfg` file to your liking:
+
+ rssEnabled="y" # Enable RSS
+ rssBlogTitle="foobar's blog"
+ rssBlogDescription="foobar loves cooking!!!!!!!"
+
And run the following:
$ chmod +x seen.sh
@@ -44,6 +48,3 @@ Seen supports other options too, for more info, run the following:
$ ./seen.sh --help
-You can create RSS feeds too, just modify the `rss.cfg` file to your liking and:
-
- $ ./seen.sh --rss