diff options
| author | Paul Buetow <pbuetow@mimecast.com> | 2021-05-19 20:38:08 +0100 |
|---|---|---|
| committer | Paul Buetow <git@mx.buetow.org> | 2021-05-21 05:11:05 +0100 |
| commit | 8c7fe3b8e55ab307431cdbfec401c9a33ac30574 (patch) | |
| tree | 419100ad77e85d9919f822f6602814c57e670130 | |
| parent | d88be863b7dcabe42b8d5b47b40ed2cb620f287c (diff) | |
more comments
| -rw-r--r-- | README.md | 2 | ||||
| -rwxr-xr-x | buetow.org.sh | 10 |
2 files changed, 9 insertions, 3 deletions
@@ -42,3 +42,5 @@ These are things I want to do with this project in near future: * Write a blog post about buetow.org.sh script * Custom alt.buetow.org domain for GitHub page. * Read through this README and make sure usage and purpose is clear. +* Add custom config file support (check alt location), and add instructions to the setup wizzard. +* Test + fix on macOS diff --git a/buetow.org.sh b/buetow.org.sh index 495cba30..21cb7419 100755 --- a/buetow.org.sh +++ b/buetow.org.sh @@ -41,7 +41,8 @@ HELPHERE setup () { if [ ! -d "$CONTENT_BASE_DIR" ]; then cat <<END -The content base directory, does not exist. Run the following to create: +The content base directory, does not exist. Run the following to create it, it +also adds some sample Gemtext content: mkdir -p $CONTENT_BASE_DIR/{meta,md,html} git clone --branch content-gemtext https://github.com/snonux/buetow.org $CONTENT_BASE_DIR/gemtext @@ -49,12 +50,15 @@ The content base directory, does not exist. Run the following to create: Once done, you are ready to edit the files in $CONTENT_BASE_DIR/gemtext. Every time you want to generate other formats from Gemtext (e.g. HTML, Markdown), run - ./buetow.org.sh --generate + $0 --generate again. +For a list of other available arguments run + $0 --help + Pro tip: You could make all the directories in $CONTENT_BASE_DIR separate git repositories or branches. You can then run - USE_GIT=yes ./buetow.org.sh --generate + USE_GIT=yes $0 --generate so that all static files are commited to the content repositories too. END exit 1 |