README.md (1988B)
1 # sbrs 2 3 A small and simple blog and RSS shell script written in POSIX shell. 4 5 ## Features 6 7 `sbrs` can do the following: 8 9 * Define a `blog` directory where all blog posts will be stored. 10 * Set up a seperate `HTML` blog page with CSS styling of your choosing. 11 * Add the blog post on the website's main and blog index pages. 12 * Add the blog post to a specified RSS feed. 13 * Revise, delete, or change the title of a published post. 14 15 Read the `man` page for more. 16 17 ## Installation 18 19 Run the `Makefile` in order to install the script. It'll 20 be installed in `usr/local/bin/`. You can change the install path 21 by editing the `BIN_DIR` variable in the `Makefile`. 22 23 ```shell 24 $ cd path/to/sbrs/ 25 $ sudo make install 26 ``` 27 28 You must **always** run the script inside your website's 29 main directory. 30 31 Alternatively, you can store the script inside your website's 32 main directory. 33 34 ## Preparation 35 36 The following files have to exist 37 * `index.html` 38 * `blogindex.html` 39 * `rss.xml` 40 * `template.html` 41 * `styles.css` 42 43 Inside the `sbrs` script, change the `website` and `author` variables 44 to your website's URL and your name and make sure the rest 45 of the variables are properly set to match your website's 46 structure. By default, all blog posts are stored in `blog/`. 47 48 `sbrs` will search for `<!--BLOG-->` inside `index.html`, 49 `blogindex.html` and `rss.xml` in order to put the blog post 50 listings and RSS feed below it. 51 52 The `template.html` file is how you want your blog post's page to look like. See 53 my own `template.html` for more. The `TITLE`, `HEADER` and `AUTHOR` 54 fields must exist and be left as is. 55 56 ## Usage 57 58 You can run the script with one of the following 59 options 60 61 ``` 62 Options: 63 -n New post 64 -p Publish draft post 65 -e Edit draft post 66 -v View draft post in browser 67 -t Delete draft post 68 -r Revise published post 69 -c Change title 70 -o View published post in browser 71 -d Delete published post 72 -l List all published posts 73 ```