summaryrefslogtreecommitdiff
path: root/website/README
blob: f8dee4af0b0b3a1c470a0eba6c5c3dce4c3724f1 (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
-*- mode: org -*-

#+TITLE: GuixSD website

This directory contains the source files for the GuixSD website,
available at https://www.gnu.org/software/guix/.

  - =www.scm= and =www= provide the =(www)= guile module which
    offers services for building the website locally.
  - =static= contains images and css for the website.
  - =mockup.svg= illustrates a homepage aimed at average users.
    This is for use when GuixSD is getting closer to a
    production-ready system.
  - =mockup-techie.svg= illustrates a homepage aimed at
    skilled devs and sysadmins.  This is for use during the
    alpha phase of development.

* Dependencies

To be able to work on the website, you need the following software:

  - [[https://www.gnu.org/software/guile/][GNU Guile]] (programming language)
  - [[http://haunt.dthompson.us/][Haunt]] (static site generator)

* Building and running

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

#+BEGIN_EXAMPLE
$ cd path/to/guix-artwork/website
$ GUIX_WEB_SITE_LOCAL=yes haunt build
$ haunt serve
#+END_EXAMPLE

Then, visit http://localhost:8080/ in a web browser.

* Deploying

Pending...

* Copying

** Guile code

See [[file:COPYING][COPYING]].

** Graphics

Public domain 2015 [[mailto:felipe.lopez@openmailbox.org][Luis Felipe López Acevedo]]

All the graphics in this directory are dedicated to the public domain, except
for the Guix System Distribution logo, which can be used under the Creative
Commons Attribution-ShareAlike 4.0 International License.

You can find information about authors and copyright in the metadata of SVG
files. If you are using Inkscape, you can access the Document metadata from
the File menu.