Skip to content

Commit 85ef1f1

Browse files
author
Benjamin Hartmann
committed
Add contribution guide
1 parent 6304a40 commit 85ef1f1

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

readme.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44

55
This repository contains the source code for the website of [CoderDojo Linz](https://linz.coderdojo.net). It is built with [Hugo](https://gohugo.io) (v0.73.0).
66

7-
## Branches
7+
## A guide to contribution
8+
9+
### Branches
810

911
* The source code of the website is in the [*develop*](https://github.com/coderdojo-linz/coderdojo-linz.github.io/tree/develop) branch.
1012
* The [*master*](https://github.com/coderdojo-linz/coderdojo-linz.github.io/tree/master) branch contains the built static website. This branch is used by GitHub Pages.
1113
* If you would like to develop new features, create a feature branch from *develop* and create a pull request when you are done.
1214

15+
### Developing with Hugo
16+
17+
Download version **v0.73.0** for your device from the [Hugo GitHub releases page](https://github.com/gohugoio/hugo/releases/tag/v0.73.0)
18+
19+
After cloning, use `npm install` to install the dependencies and `hugo` to build the page to the `public/` folder. Use `npm run server` to start a local dev server at `http://localhost:1313/`
20+
1321
## DNS
1422

1523
* The website is made available by GitHub Pages at [https://coderdojo-linz.github.io](https://coderdojo-linz.github.io). This is **not** our official DNS name. We used it in the past and it exists because of historical reasons.

0 commit comments

Comments
 (0)