Git-Mirrors/censorbib
1
0
Fork 0
mirror of https://github.com/NullHypothesis/censorbib.git synced 2025-07-22 06:09:10 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update README.

Browse source 
Remove now-obsolete text and add contribution guidelines.
This commit is contained in:
Philipp Winter 2024-03-09 22:33:50 -06:00
parent 1eeb1267b3
commit e810813681
1 changed files with 14 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -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 <phw@nymity.ch>
> [!TIP]
> Try to mimic the style of existing BibTeX entries. The parser is strict!