From 88bfebb2517ec5ebd9e7ee311c809a2397b9fc93 Mon Sep 17 00:00:00 2001 From: Bradley Taunt Date: Fri, 29 Jul 2022 10:46:26 -0400 Subject: [PATCH] Update README --- README.md | 18 +++++++++++++++++- _config.sh | 2 +- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81257d6..994cd7d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # pblog -Pandoc static blog generator \ No newline at end of file +Pandoc static blog generator + +[https://pblog.xyz](https://pblog.xyz) + +## Getting Started + +You can always read through the up-to-date article: [Introducing pblog](https://pblog.xyz/blog/pblog-intro.html) + +But very basic steps: + +1. Install dependencies +2. Write posts in the `posts` directory +3. Write pages in the `pages` directory +4. Build the site +5. Upload your `_output` folder to your web host + +Enjoy! diff --git a/_config.sh b/_config.sh index c9d2621..c8b3cee 100644 --- a/_config.sh +++ b/_config.sh @@ -7,7 +7,7 @@ TITLE="pblog.xyz" DESCRIPTION="Pandoc static blog generator" COPYRIGHT="Copyright 2022, Bradley Taunt" AUTHOR="hello@tdarb.org (Bradley Taunt)" -OS="Linux" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS) +OS="BSD" # "Linux" for Linux, "BSD" for BSD Systems (including MacOS) HTML_LANG="en_US" # Your document (HTML) language setting # Blog structure settings (most users should use these defaults)