diff options
| author | Paul Buetow <git@mx.buetow.org> | 2021-05-19 20:10:19 +0100 |
|---|---|---|
| committer | Paul Buetow <git@mx.buetow.org> | 2021-05-21 05:11:05 +0100 |
| commit | 202f4e03fb9519931142fcd3d76700aeb106a05d (patch) | |
| tree | acd094ea1d4bad74735334f1d7107d87c60ac830 /README.md | |
| parent | 14822623456972b0dbe9dc5b6c36b701bb6ec7f1 (diff) | |
fix
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -14,11 +14,26 @@ This is the source code of my Gemini capsule. You can reach the site(s) here: * Text editor: [Vim](https://www.vim.org) * Gemini server: [a-h/gemini](https://github.com/a-h/gemini) * Some Bash scripting (GNU Bash probably 5.x or higher required) +* ShellCheck is also required to be installed. ## HTTP fallback software used * Web server: [Apache HTTPD](https://httpd.apache.org) +# Usage + +To get started just clone this repo (master branch) and run ./buetow.org.sh. You +will will be prompted with further instructions. + +Once done, you can edit the Gemtext source and then use the buetow.org.sh script +to generate the other output formats such as: + +* HTML +* Markdown (works also with GitHub pages as you saw) +* Meta (that's only generating meta info for the blog post, used for Atom feed generation) + +Do a ./buetow.org.sh --help for a list of all available arguments. + ## TODO These are things I want to do with this project in near future: |