Skip to content

Commit c19160e

Browse files
authored
Add docs for Hugo and ignore locally generated resources (#5)
1 parent 9d417a5 commit c19160e

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
resources/_gen/

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
1-
## README
2-
Code repository for XSpec website.
1+
# README
2+
Repository for XSpec website [xspec.io](https://xspec.io).
3+
4+
The default branch is the `hugo` branch, containing the sources of the actual website.
5+
6+
To run a local version:
7+
8+
* [Install Hugo following their instructions](https://gohugo.io/getting-started/installing/).
9+
* Clone or download this repository from GitHub.
10+
* Checkout the branch `hugo`: `git checkout hugo`
11+
* Install the git submodules: `git submodule update --init --recursive`
12+
* Run `hugo server -D` to get a local version of the website.
13+
14+
To submit updates: create a pull request to the `hugo` branch.
15+
16+
## Background
17+
18+
The website is generated as a static site using [Hugo](https://gohugo.io/). The static site is stored in the `master` branch, and GitHub publishes the static site.

0 commit comments

Comments
 (0)