Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Perfect5th authored Jan 21, 2024
1 parent e82c490 commit e3aba83
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ respectively.

If you need more than one file, either get clever or edit `./templates/base.html` or `./templates/close.html`.

## Testing locally

Make sure you have `markdown` installed. You can get it from [the Markdown Homepage][2] or your favourite package manager probably.
Make sure you have a POSIX shell of some kind.

Execute `./convert.sh`, which builds your site in `_site`. You can then serve this directory however you see fit – use the `file://`
protocol in your browser or a simple server like `python3 -m http.server`.

Things I may or may not do:
* templates, or at least a bit more customization
* github pages serving (DONE)
Expand All @@ -28,3 +36,4 @@ Things I may or may not do:
* tbd

[1]: https://github.com/Perfect5th/perfect5th.github.io "Perfect5th's Personal Site Repo"
[2]: https://daringfireball.net/projects/markdown/ "Daring Fireball Markdown Project Page"

0 comments on commit e3aba83

Please sign in to comment.