aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 43bda2f14ae6b41eeb57d280075ff66acd5612c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# wruby

> This is a heavy work-in-progress. Consider this in alpha state.

Minimal blog and static site generator. The "w" is silent...

## Dependencies

- `ruby`

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