Skip to content

Commit

Permalink
Minor corrections in README
Browse files Browse the repository at this point in the history
  • Loading branch information
JanssenSimon committed Oct 16, 2022
1 parent adf1df1 commit b79a2be
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,27 @@ Dynamic Static Website generator using inotify and pandoc to convert Markdown
files into html pages.

## DEPENDENCIES:
1. Linux (using systemd)
2. Posix compliant shell (some other shells work)
3. pandoc
4. inotify-tools
- linux (using systemd)
- posix compliant shell (some other shells work)
- pandoc
- inotify-tools

## INSTRUCTIONS
0. If not already done, make wimp script executable
1. run wimp
2. put your markdown files in src/ and your style containing html files in includes/
3. point a webserver to public/
0. Make wimp script executable (`chmod +x wimp`)
1. Run wimp
2. Put your markdown files in `src/` and your style containing html files in `includes/`
3. Point a webserver to `public/`
4. ???
5. profit.
5. Profit.


## What's in the works?
1. support the following flags for pandoc:
- --template
- -V
- --css
2. figure out how to run on startup or something when initializing
use systemd to make it work
3. make names of folders and things configurable using variables
1. Figure out how to run wimp watch on startup using systemd.
2. Have the wimp delete html files when their corresponding markdown file is deleted
from `src/`.
3. Make names of folders configurable using variables;
also add a config option for compilation of all files.
4. Support the following flags for pandoc:
- --template
- -V
- --css

0 comments on commit b79a2be

Please sign in to comment.