sbrs

Simple blog and RSS system
git clone git://git.christosmarg.xyz/sbrs.git
Log | Files | Refs | README | LICENSE

README (1658B)


      1 sbrs
      2 ====
      3 A small and simple blog and RSS shell script written in POSIX shell.
      4 
      5 Preparation
      6 -----------
      7 Inside the 'sbrs' script, change the 'WEBSITE' and 'AUTHOR' variables
      8 to match your website's URL and your name.
      9 
     10 In case you don't edit the script further, the structure of your
     11 website's directory should look like this. The files below need
     12 to exist with the same names.
     13 
     14         ├── articles
     15         |   └── here reside your articles
     16         ├── index.html
     17         ├── articles.html
     18         ├── template.html
     19         └── rss.xml
     20 
     21 Inside 'index.html', 'articles.html' and 'rss.xml' sbrs will search for
     22 <!--SBRS--> in order to put the article listings and RSS feed below it.
     23 
     24 The 'template.html' file is how you want your article's page to look like.
     25 See my own 'template.html' for more. The 'TITLE', 'HEADER' and 'AUTHOR'
     26 fields must exist and be left as is.
     27 
     28 Installation 
     29 ------------
     30 sbrs will be installed in /usr/local/bin
     31 
     32         cd path/to/sbrs/
     33         sudo make install
     34 
     35 Usage
     36 -----
     37 You must always run the script inside your website's main directory.
     38 Run it with one of the following options. Only one option can be used
     39 at a time.
     40 
     41 Options:
     42   -n        New post
     43   -p        Publish draft post
     44   -e        Edit draft post
     45   -v        View draft post in browser
     46   -t        Delete draft post
     47   -r        Revise published post
     48   -c        Change title
     49   -o        View published post in browser
     50   -d        Delete published post
     51   -l        List all published posts
     52 
     53 Notes:
     54 ------
     55 Do NOT edit the various comments that the script writes inside the files,
     56 otherwise it'll not work properly, or work at all.