Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JanssenSimon authored Jan 16, 2023
1 parent caceb37 commit 73a198b
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -5,15 +5,18 @@ files into html pages.
My goal with this software is to make it self-sufficient.

## DEPENDENCIES:
- linux (using systemd and sudo)
- posix compliant shell (some other shells work)
- linux (using systemd, sudo, and some posix compliant shell)
- pandoc
- inotify-tools

## INSTRUCTIONS
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/`
1. Run `wimp init`
2. Put your markdown files in `src/`
3. Point a webserver to `public/` if you want to
4. ???
5. Profit.

## POSIX
This shell script is supposed to be posix compliant; it not being so is a bug.
Feel free to report any bugs you find.

0 comments on commit 73a198b

Please sign in to comment.