Skip to content

Commit 4d43757

Browse files
add some text on installation & usage
1 parent f84ca0c commit 4d43757

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,17 @@ Sample websites using Gozer:
1212
- [Simplest possible example](example/)
1313
- [My personal website](https://github.com/dannyvankooten/www.dannyvankooten.com)
1414

15-
## Directory structure
1615

17-
Gozer expects the following directory structure in order to generate your site.
18-
You can create this structure by running `gozer new`.
16+
## Installation
17+
You can install Gozer using one of the following methods:
18+
19+
- Download a precompiled binary from the [latest release](https://github.com/dannyvankooten/gozer/releases)
20+
- If you have the Go compiler installed: `go install github.com/dannyvankooten/gozer@latest`
21+
22+
23+
## Usage
24+
25+
Run `gozer new` to quickly generate an empty directory structure.
1926

2027
```txt
2128
content/ # Your posts and pages
@@ -24,7 +31,9 @@ public/ # Any static files
2431
config.toml # Configuration file
2532
```
2633

27-
Placing Markdown files in your `content/` directory will create a page in your build directory after running `gozer build`.
34+
Then, run `gozer build` to generate your site.
35+
36+
Any Markdown files placed in your `content/` directory will result in an HTML page in your build directory after running `gozer build`.
2837

2938
For example:
3039

0 commit comments

Comments
 (0)