Skip to content

Commit 5e8a77c

Browse files
committed
Add README
1 parent f7ee9d7 commit 5e8a77c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Faremeter's Public Website
2+
--------------------------
3+
4+
This website uses [hugo](https://gohugo.io). You can modify the CSS, themes, and settings, and adjust it however you'd like. See the [hugo documentation](https://gohugo.io/documentation/) for more information.
5+
6+
It's currently very informal. Just commit your changes (make sure they're actually ones you want live) and push your branch to GitHub's `main`.
7+
8+
0. Setup your environment
9+
10+
On macOS you need homebrew. To install hugo just do:
11+
12+
```
13+
brew install hugo
14+
```
15+
16+
17+
1. Previewing content
18+
19+
```
20+
hugo serve
21+
```
22+
23+
and then browse to http://localhost:1313/
24+
25+
2. Publishing Content
26+
27+
`git add` your content, and then commit. Once you've done that, run:
28+
29+
```
30+
hugo build
31+
```
32+
33+
and `git add` the contents of `public`. Once you `git push` the `main` branch to GitHub, the site will automatically be published.

0 commit comments

Comments
 (0)