summaryrefslogtreecommitdiff
path: root/README
blob: 425869def38ba98e6e52c08ef56c9643fff1dced (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
-*- mode: org -*-

#+TITLE: the Hurd website

The Hurd website available at https://www.gnu.org/software/hurd/ is a
static website built with [[https://ikiwiki.info/][Ikiwiki]].  This directory contains the source
files of the website.

* Development environment

The folling dependencies are needed to build the website

   ikiwiki,
   perl,
   cpan Text::Markdown,
   cpan Search::Xapian,
   cpan YAML::Syck, and
   Texinfo

On Debian, do something like:

#+BEGIN_EXAMPLE
sudo apt-get install ikiwiki perl libtext-markdown-perl \
    libsearch-xapian-perl libyaml-syck-perl texinfo
#+END_EXAMPLE

To setup a development environment for Guix, do:

#+BEGIN_EXAMPLE
guix shell ikiwiki perl perl-text-markdown perl-search-xapian perl-yaml-syck texinfo
#+END_EXAMPLE

* Running the website

To try out the website locally while you work on it, run the following
commands:

#+BEGIN_EXAMPLE
rm -rf ../web.rendered
./render_locally
#+END_EXAMPLE

the website is built out of tree (!) in in [[file:~/src/hurd/web.rendered][../web.rendered]].