Skip to content

Commit e1a07ce

Browse files
committed
Add acknowledgements chapter
1 parent dbdbed5 commit e1a07ce

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

README.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,36 @@ are also very welcome. Please report them on the `github issue tracker
127127
<https://github.com/rhpvorderman/python-isal/issues>`_.
128128

129129
.. contributing end
130+
131+
Acknowledgements
132+
----------------
133+
134+
.. acknowledgements start
135+
136+
This project builds upon the software and experience of many. Many thanks to:
137+
138+
+ The `ISA-L contributors
139+
<https://github.com/intel/isa-l/graphs/contributors>`_ for making ISA-L.
140+
+ The `Cython contributors
141+
<https://github.com/cython/cython/graphs/contributors>`_ for making it easy
142+
to create an extension and helping a novice get start with pointer addresses.
143+
+ The `CPython contributors
144+
<https://github.com/python/cpython/graphs/contributors>`_.
145+
Python-isal mimicks ``zlibmodule.c`` and ``igzip.py`` to make it easier for
146+
python users to adopt it.
147+
+ `@marcelm <https://github.com/marcelm>`_ for taking a chance on this project
148+
and make it a dependency for his `xopen
149+
<https://github.com/pycompression/xopen>`_ and by extension `cutadapt
150+
<https://github.com/marcelm/cutadapt>`_ projects. This gave python-isal its
151+
first users who used python-isal in production.
152+
+ The `github actions team <https://github.com/orgs/actions/people>`_ for
153+
creating the actions CI service that enables building and testing on all
154+
three major operating systems.
155+
+ `@animalize <https://github.com/animalize>`_ for explaining how to test and
156+
build python-isal for ARM 64-bit platforms.
157+
+ And last but not least: everyone who submitted a bug report or a feature
158+
request. These make the project better!
159+
160+
Python-isal would not have been possible without you!
161+
162+
.. acknowledgements end

docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,11 @@ Contributing
6666
:start-after: .. contributing start
6767
:end-before: .. contributing end
6868

69+
================
70+
Acknowledgements
71+
================
72+
.. include:: includes/README.rst
73+
:start-after: .. acknowledgements start
74+
:end-before: .. acknowledgements end
75+
6976
.. include:: includes/CHANGELOG.rst

0 commit comments

Comments
 (0)