aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-07-21 12:18:17 -0400
committerBradley Taunt <bt@btxx.org>2024-07-21 12:18:17 -0400
commitb5ab99baf2f2f1e2418640070fda397003ff3dd5 (patch)
tree2c0f6dae2a489faa1230cb51911410c7330914f5 /README.md
parentca10d78e63a3caf8b79ac7b73ff483a7150c2683 (diff)
Update README, add directories, image, LICENSE, and build config
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9c6e1ff..43bda2f 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,16 @@ Install required gems:
gem install kramdown rss
```
+## Getting Started
+
+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.
+
## 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 \ No newline at end of file
+5. Upload `build` folder to your server