commit 39aae6a

meta: generate_pages -> glerc

 1@@ -3,10 +3,10 @@
 2 GO ?= go
 3 
 4 all:
 5-	$(GO) build ./cmd/generate_pages
 6+	$(GO) build ./cmd/glerc
 7 
 8 clean:
 9-	rm generate_pages
10+	rm glerc
11 
12 lint:
13 	$(GO) fmt ./...

 1@@ -1,33 +1,28 @@
 2-# pages
 3-![pages' logo](assets/logos/pages_logo.png)
 4+# glerc
 5 
 6 A small, werc-inspired and easy to use SSG, written in Go - Write pages in markdown, get them back as HTML files with a nice lil sidebar :D
 7 
 8- 
 9+## building
10 
11-## usage
12-
13-Using pages is very simple!!
14+To build glerc, you need `go >= 1.26.2`.
15 
16-![lil gopher!! :D](assets/logos/gopher.png)
17+Running `make` in the root of the repository should give you a binary called `./glerc`
18 
19-First, get [Go](https://go.dev/dl/), then when you clone the repo just:
20+## usage
21 
22-1. Put your markdown files in `pages/`
23-2. Put any images you may have in `assets/`
24-3. Run with `go run ./cmd/...`
25-4. Get your HTML files from `output/`
26+We recommend you look at [The Dani Museum](https://codeberg.org/dani-institute/pages) to get an idea of what a page in glerc should look like.
27 
28-And pow!! Very simple to use!! :D
29+The rundown is this:
30+- HTML templates go in `templates/` and must end with `.html`.
31+- Assets (CSS, JS, images) go in `assets/`, we recommend organising them.
32+- Pages go in `pages/` and must end with `.md`.
33 
34- 
35+(Documentation on what options the HTML template accepts will be documented when possible.)
36 
37 ## configuration
38 
39-Use`config.toml` to set your site's title, description and base URL. You can also set the sidebar order by doing the following :3
40+Use `config.toml` to set your site's title, description and base URL. You can also set the sidebar order by doing the following :3
41 
42 ```toml
43 sidebar_order = ["index", "page1", "page2"]
44 ```
45-
46-