README.md 1.17 KB
Newer Older
Etienne's avatar
Etienne committed
1
2
3
4
5
Shuttleworth Foundation - Annual Report 2013
============================================

This repository contains the 2013 annual report infographic for the
Shuttleworth foundation. Jekyll input files are generated from the
6
`src/templates` and `src/data` files using the scripts provided and then
Etienne's avatar
Etienne committed
7
8
9
10
11
12
13
14
15
16
17
18
19
integrated into the main shuttleworthfoundation.org Jekyll page.

Checking out
------------

The repository is intended to be a submodule of the main
shuttleworthfoundation.org repository. The best way to get a copy of
this repository is to clone the main shuttleworthfoundation.org
repository with:

```shell
$ git clone --recursive git@github.com:ShuttleworthFoundation/shuttleworthfoundation.org.git
```
Jason Hudson's avatar
Jason Hudson committed
20
21
22
23
Requirements
--------

You will need python, python-virtualenv and jekyll installed on your machine.
Etienne's avatar
Etienne committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

Building
--------

The page is build using the included `Makefile`. Everything is
automated so it is very simple.

```shell  
$ make
```

The makefile is also automatically called from the main `Makefile`
added to the main shuttleworthfoundation.org repository, so building
the entire website should be as simple as calling `make` from the
root of the repository after doing a recursive clone.