Skip to content

Commit e810813

Browse files
Update README.
Remove now-obsolete text and add contribution guidelines.
1 parent 1eeb126 commit e810813

File tree

1 file changed

+14
-22
lines changed

1 file changed

+14
-22
lines changed

README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,19 @@
1-
Overview
2-
--------
1+
# CensorBib
32

4-
This repository contains the BibTeX file and HTML templates that form the
3+
This repository contains the
4+
[BibTeX file](references.bib)
5+
and
6+
[corresponding tooling](src/)
7+
that powers the
58
[Internet Censorship Bibliography](https://censorbib.nymity.ch).
9+
CensorBib is also available via
10+
[GitHub pages](https://NullHypothesis.github.io/censorbib/)
11+
in case the primary domain is inaccessible to you.
612

7-
Build it
8-
--------
13+
## Contribute
914

10-
You first need [`bibliogra.py`](https://github.com/NullHypothesis/bibliograpy)
11-
to turn the BibTeX file into an HTML bibliography.
15+
To contribute, please create a pull request that adds a new paper or
16+
improves an existing one.
1217

13-
Then, run the following commands to write the bibliography to `OUTPUT_DIR`.
14-
15-
$ ./fetch_pdfs.py references.bib OUTPUT_DIR
16-
$ bibliogra.py -H header.tpl -F footer.tpl -f references.bib OUTPUT_DIR
17-
18-
Acknowledgements
19-
----------------
20-
21-
CensorBib uses [Font Awesome](https://fontawesome.com/license/free) icons
22-
without modification.
23-
24-
Feedback
25-
--------
26-
27-
Contact: Philipp Winter <[email protected]>
18+
> [!TIP]
19+
> Try to mimic the style of existing BibTeX entries. The parser is strict!

0 commit comments

Comments
 (0)