Documentation Update
This commit is contained in:
parent
c26e9ed80f
commit
d0b24f5ad7
28
README.md
28
README.md
@ -1,8 +1,8 @@
|
||||
This is a BSD Makefile base webpage generator.
|
||||
# This is a BSD Makefile base webpage generator.
|
||||
|
||||
Pretty minimal... no features at all.
|
||||
|
||||
It needs:
|
||||
## Requirements:
|
||||
|
||||
- BSD make (written and tested on OpenBSD)
|
||||
- discount (for parsing markdown file)
|
||||
@ -10,7 +10,7 @@ It needs:
|
||||
- ksh (for shell stuff)
|
||||
- rsync (to copy static files)
|
||||
|
||||
Basic operation:
|
||||
## Basic operation:
|
||||
|
||||
src/header.th gets prepended to every file.
|
||||
src/footer.th gets appended to every file.
|
||||
@ -18,16 +18,26 @@ src/footer.th gets appended to every file.
|
||||
.pa files contain asciidoctor source.
|
||||
.pm files contain markdown source.
|
||||
.ph files contain plain html.
|
||||
.ps files contain ksh shell script (the scripts must output html to stdout).
|
||||
.ps files contain ksh shell script (the scripts must output html code to stdout).
|
||||
.pt files contain plain text.
|
||||
|
||||
Everything in `.control/static-files` is copied as is.
|
||||
|
||||
Execute `make debug` to create the website with debug output.
|
||||
Execute `make` to hide the debug output.
|
||||
Execute `make install` to copy the page to the remote in `.control/remote-ssh-target`.
|
||||
Execute `make install` to copy the page to the remote host.
|
||||
|
||||
The generated website will be in the directory `www`.
|
||||
|
||||
Execute `make clean` to delete www. Or just `rm -rf www`, if you want
|
||||
to start over.
|
||||
Execute `make clean` to delete www.
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration happens in the `.control`. Toggles are files and their
|
||||
content is the value.
|
||||
|
||||
Configure the remote host for `make install`.
|
||||
```
|
||||
echo "user@my-server.de:/var/www" > .control/remote-ssh-host
|
||||
```
|
||||
|
||||
Everything in `.control/static-files` is copied as is (supports globbing).
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user