From ef31862ca65c161e09589ac07d5b55c57da8d1d3 Mon Sep 17 00:00:00 2001 From: Philipp Winter Date: Mon, 18 May 2015 20:20:37 +0200 Subject: [PATCH] Update README. --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bbe1dc..dbd3021 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# censorbib -Internet censorship bibliography +Overview +-------- +This repository contains the BibTeX file and HTML templates that are used to +create the [Internet censorship bibliography](http://censorbib.nymity.ch). + +Build it +-------- + +You first need [`bibliogra.py`](https://github.com/NullHypothesis/bibliograpy) +to turn the BibTeX file into an HTML bibliography. + +Then, run the following command to write the bibliography to `OUTPUT_DIR`. + + $ bibliogra.py -H header.tpl -F footer.tpl -f references.bib OUTPUT_DIR + +Feedback +-------- +Contact: Philipp Winter +OpenPGP fingerprint: `B369 E7A2 18FE CEAD EB96 8C73 CF70 89E3 D7FD C0D0`