diff --git a/README.md b/README.md index e97daa8..976c1e5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -This is where all sources related to my Gemini capsule and my website. +# stevengibone.com gemini capsule +This is where all sources related to my Gemini capsule and my website go. You will find both the content I write and the script I use to generate the html from the gemtext files. @@ -9,16 +10,16 @@ I write everything in gemtext first and only then generate the html for the web. ## Configuration The script needs a config file to provide the remote servers and some directory -paths. +paths. The script uses rsync to push files to the server so go check its manual if +you need help settings `RGMI` and `RHTML`. -``` -WORKDIR=~/dev/gemini-capsule -ASSETS=$WORKDIR/assets - -LGMI=~/dev/gemini-capsule/content/ -RGMI=user@remote.server:/directory - -HTMLPARTS=~/dev/gemini-capsule/html-parts -LHTML=~/dev/gemini-capsule/html-output/ -RHTML=user@remote.server:/directory -``` +| variable name | description | +|---------------|---------------------------------------| +| WORKDIR | base directory | +| ASSETS | | +| LGMI | local directory with all your gemtext | +| RGMI | remote directory to put your gemtext | +| HTML_HEADER | | +| HTML_FOOTER | | +| LHTML | local directory to put generated HTML | +| RHTML | remote directory to put your HTML |