From e81081368173a251fefd0fc1203ae324780e64e1 Mon Sep 17 00:00:00 2001 From: Philipp Winter Date: Sat, 9 Mar 2024 22:33:50 -0600 Subject: [PATCH] Update README. Remove now-obsolete text and add contribution guidelines. --- README.md | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 50c8ba7..9ff1fa7 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,19 @@ -Overview --------- +# CensorBib -This repository contains the BibTeX file and HTML templates that form the +This repository contains the +[BibTeX file](references.bib) +and +[corresponding tooling](src/) +that powers the [Internet Censorship Bibliography](https://censorbib.nymity.ch). +CensorBib is also available via +[GitHub pages](https://NullHypothesis.github.io/censorbib/) +in case the primary domain is inaccessible to you. -Build it --------- +## Contribute -You first need [`bibliogra.py`](https://github.com/NullHypothesis/bibliograpy) -to turn the BibTeX file into an HTML bibliography. +To contribute, please create a pull request that adds a new paper or +improves an existing one. -Then, run the following commands to write the bibliography to `OUTPUT_DIR`. - - $ ./fetch_pdfs.py references.bib OUTPUT_DIR - $ bibliogra.py -H header.tpl -F footer.tpl -f references.bib OUTPUT_DIR - -Acknowledgements ----------------- - -CensorBib uses [Font Awesome](https://fontawesome.com/license/free) icons -without modification. - -Feedback --------- - -Contact: Philipp Winter +> [!TIP] +> Try to mimic the style of existing BibTeX entries. The parser is strict! \ No newline at end of file