From 514e34914cfbb89b2c816d25d1d74aee3780a15a Mon Sep 17 00:00:00 2001 From: Janneke Nieuwenhuizen Date: Wed, 4 Dec 2024 19:10:32 +0100 Subject: Add README. * README: New file, documenting dependencies and development build. Message-ID: <20241204181037.24687-1-janneke@gnu.org> --- README | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 00000000..425869de --- /dev/null +++ b/README @@ -0,0 +1,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]]. -- cgit v1.2.3