Improve `README.md` and add the contribution guide to the docs

.gitignore

@@ -119,7 +119,6 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/changes.md
 
 # PyBuilder
 target/

README.md

@@ -50,11 +50,12 @@ HMMER internals, which has the following advantages over CLI wrappers
   and its fixed-width tabular output, which is hard to parse (even
   [`Bio.SearchIO.HmmerIO`](https://biopython.org/docs/dev/api/Bio.SearchIO.HmmerIO.html)
   is struggling on some sequences).
-- **no performance penalty**: Using `pyhmmer` to launch `hmmsearch` on sequences
+- **efficient**: Using `pyhmmer` to launch `hmmsearch` on sequences
   and HMMs in disk storage is typically not slower than directly using the
   `hmmsearch` binary (see the [Benchmarks section](#%EF%B8%8F-benchmarks)).
-  If you already have everything in memory, saving the writing/reading step
-  possibly gives you a slight boost!
+  `pyhmmer.hmmsearch` uses a different parallelisation strategy compared to
+  the `hmmsearch` binary from HMMER, which helps getting the most of
+  multiple CPUs.
 
 *This library is still a work-in-progress, and in a very experimental stage,
 but it should already pack enough features to run simple biological analyses
@@ -63,7 +64,7 @@ involving `hmmsearch`.*
 
 ## 🔧 Installing
 
-``pyhmmer`` can be installed from [PyPI](https://pypi.org/project/pyhmmer/),
+`pyhmmer` can be installed from [PyPI](https://pypi.org/project/pyhmmer/),
 which hosts some pre-built CPython wheels for x86-64 Linux and OSX,
 as well as the code required to compile from source with Cython:
 ```console
@@ -112,6 +113,20 @@ the `cpus` argument of the `pyhmmer.hmmsearch` function, as HMMER cannot
 benefit from hyperthreading*.
 
 
+## 💭 Feedback
+
+### ⚠️ Issue Tracker
+
+Found a bug ? Have an enhancement request ? Head over to the [GitHub issue
+tracker](https://github.com/althonos/pyhmmer/issues) if you need to report
+or ask something. If you are filing in on a bug, please include as much
+information as you can about the issue, and try to recreate the same bug
+in a simple, easily reproducible situation.
+
+### 🏗️ Contributing
+
+See `CONTRIBUTING.md`.
+
 ## ⏱️ Benchmarks
 
 Benchmarks were run on a i7-8550U CPU running at 1.80GHz, using a FASTA file

docs/changes.md

+../CHANGELOG.md
\ No newline at end of file

docs/conf.py

@@ -34,9 +34,6 @@ def setup(app):
     app.add_css_file("css/main.css")
     # app.add_js_file("js/apitoc.js")
     # app.add_js_file("js/example-admonition.js")
-    # Copy `CHANGELOG.md` from project directory
-    changelog_src = os.path.join(project_dir, "CHANGELOG.md")
-    changelog_dst = os.path.join(docssrc_dir, "changes.md")
     shutil.copy(changelog_src, changelog_dst)
 
 

docs/contributing.md

+../CONTRIBUTING.md
\ No newline at end of file

docs/index.rst

@@ -71,6 +71,7 @@ Library
    Installation <install>
    Examples <examples/index>
    API Reference <api/index>
+   Contributing <contributing>
    Changelog <changes>