updated readme to be more detailed

This commit is contained in:
nytpu 2020-09-09 23:10:19 -06:00
parent 76fb49e3d8
commit c86b7ce424
Signed by: nytpu
GPG Key ID: ECCDC07B337B8F5B
1 changed files with 18 additions and 9 deletions

View File

@ -1,15 +1,24 @@
# gemlog.sh
Utility for writing and managing gemini logs (gemlogs) without needing cgi.
Utility for writing and managing gemini logs (gemlogs) and atom feeds without
needing a cgi script.
To install: put it wherever you want and just add it to path
To install:
1. put it wherever you want and just add it to path
2. make sure you modify `make_globals()` and `build_entries()` in the script to
customize it to your gemlog.
To use:
1. write your post in .gmi format
the script will display all posts starting with a number in reverse
alphabetical order, so I recommend naming your post in the format
`YYYY-MM-DD.gmi`. the first heading line of any depth in the document will
be used as a title
2. make sure you're in your gemlog directory then run `gemlog.sh` to build
3. if you want rss, symlink the feed.rss file to your html server directory
1. Make sure to
2. Write your post in .gmi format. The first header of any level on the page
will be used as a title (it doesn't have to be on the first line). The
script will detect any .gmi files that start with a number and assume
they're blog posts. It'll display them in reverse alphabetical order, so I
recommend to name your files like `YYYY-MM-DD.gmi` or
`YYYY-MM-DD-title-here.gmi` so you get them sorted nicely in reverse
chronological order.
3. make sure you're in your gemlog directory then run `gemlog.sh` to build the
index page and the atom feed
4. if you want your atom feed to be accessible over the web as well as gemini,
symlink the atom.xml file to your web server directory