commit c602224bf9407b4592ce0c5ed540ec7e9c9ddc9c
parent 5554618a7b03e9f40296ad6671a3c3a2a88f0218
Author: Overseer <overseer@mona.qualityreto.net>
Date: Sat, 24 Feb 2018 00:10:42 -0600
Updated README with some usage info
Diffstat:
1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -12,6 +12,25 @@ A simple blog software that doesn't require a database, and separates content fr
-- Can port existing HTML pages and posts directly into just-a-blog with no need to reformat. (Just remember to change the extension to .md)
- Full customization - Since just-a-blog strives to be small and lightweight, editing it should be extremely easy.
+## Install
+
+Installing is dead simple. Simply `git clone https://github.com/robertdherb/just-a-blog` in the directory you serve http pages from. You will also need to make some changes to your httpd to allow it to serve canonical URLs.
+
+## Use
+
+Place markdown files in the posts/ directory. The file name should be the post's title. For instance, a post titled, "My First Post" should be in the file posts/my-first-post.md.
+
+Pages work the same, but are placed in the pages/ directory.
+
+Do not delete pages/home.md. Alter it however you like, but it needs to exist.
+
+Posts are sorted by last edit time. This moves recently edited posts to the top of the list. This may or may not be a desirable outcome for you.
+
+## TODO
+
+ - I never commited Parsedown.html, so be sure to do that some time.
+ - Make it easier to siwtch cannonical URLs on and off
+
## Contact
Send an email to just-a-blog@robertdherb.com, or try to find me on Skype (rawbherb) or Steam (abigtimeoperator)
