add README and gitignore

This commit is contained in:
stev 2023-02-22 00:43:48 +01:00
parent 2e5cf2664e
commit 21091dadfd
2 changed files with 26 additions and 0 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
*.conf
*.temp

24
README.md Normal file
View file

@ -0,0 +1,24 @@
This is where all sources related to my Gemini capsule and my website.
You will find both the content I write and the script I use to generate the html from
the gemtext files.
> Lots of things will change in the script to make it more flexible and sensible.
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.
```
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
```