aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-07-21 12:50:55 -0400
committerBradley Taunt <bt@btxx.org>2024-07-21 12:50:55 -0400
commit34d1e1144d1f47c37e2b2d9c251f6c86029a5986 (patch)
tree1aee9f3cfe33a90fc90279b12624741a52fc5df3
parent38933a8b7bd335a00b360595213021f064c35cd7 (diff)
Update README info with better details
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index 43bda2f..ab4c3fe 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# wruby
-> This is a heavy work-in-progress. Consider this in alpha state.
+> This is a heavy work-in-progress and I am hardly a Ruby expert.
+>
+> Please consider contributing to make the project better!
Minimal blog and static site generator. The "w" is silent...
@@ -20,10 +22,14 @@ Make your changes in the top of the main `wruby.rb` file (site URL, your name,
etc.). Remove the `.build.yml` unless you plan to host with sourcehut pages,
otherwise edit this file with your own details.
+* Blog posts go under the `posts` directory as markdown files
+ - Posts need to be structured with an `h1` on the first line, a space on the
+ second, and the date on the third line (ie. 2024-07-20)
+* Pages go under the `pages` directory as markdown files
+* Media (images, videos etc) go in the root `public` directory
+
## Running
-1. Create markdown blog posts under root `posts/` directory
-2. Create markdown pages under root `/pages` directory
-3. Store media (images, videos etc) inside the root `/public` directory
-4. Run `make build` in root
-5. Upload `build` folder to your server
+1. Run `make build` in the root directory
+2. Upload `build` folder to your server
+3. Share your blog or site!