Update README.md

Julien LepillerThu Apr 11 23:45:54+0200 2019

249ffeb

Update README.md

README.md

11
# nani.framagit.io
22
3-
The website code for the nani project
3>
40>
\ No newline at end of file
3+
This repository contains the code for the website of the Nani project.
4+
It uses haunt to build a static website and some guile code to generate
5+
dictionaries and downloadable content for the project.
6+
7+
## Building and testing
8+
9+
### Dependencies
10+
11+
To build the website, you will need the following software:
12+
13+
* haunt
14+
* guile
15+
16+
The easiest way to do this is to use [guix](https://gnu.org/software/guix) and
17+
install the necessary components in a temporary environment:
18+
19+
```bash
20+
guix environment --ad-hoc guile haunt
21+
```
22+
23+
### Testing locally
24+
25+
To test the website, build it with:
26+
27+
```bash
28+
haunt build
29+
```
30+
31+
This can take quite a lot of time because it needs to build a lot data.
32+
33+
Then run a server with:
34+
35+
```bash
36+
haunt serve
37+
```
38+
39+
You can now connect to localhost to view the website.
39<
040<
\ No newline at end of file