Update README

Julien LepillerWed Apr 17 11:34:40+0200 2019

113ecff

nani/website
namelast commitdate
.gitignoreUpdate READMEWed Apr 17 11:34:40+0200 2019
COPYINGAdd licenseThu Apr 11 23:50:22+0200 2019
MakefileAdd make to build dictionariesWed Apr 17 11:29:09+0200 2019
README.mdUpdate READMEWed Apr 17 11:34:40+0200 2019
modules/Compress tags.Wed Apr 17 11:12:15+0200 2019
tools/Add make to build dictionariesWed Apr 17 11:29:09+0200 2019

README.md

nani.framagit.io

This repository contains the code for the website of the Nani project. It uses haunt to build a static website and some guile code to generate dictionaries and downloadable content for the project.

Building and testing

Dependencies

To build the website, you will need the following software:

As well as more common software:

The easiest way to do this is to use guix and install the necessary components in a temporary environment:

guix environment --ad-hoc guile haunt

Testing locally

To test the website, build it with:

make

This can take quite a lot of time because it needs to build a lot data.

Then run a server with:

haunt serve

You can now connect to localhost to view the website.

Updating dictionary data

Dictionaries are served by this website. The first time you build the website, make will take care of downloading the necessary data and building the dictionary files. Later, it will not download the files anymore, but you can update them explicitly with:

make download