diff options
| author |  Théo Zimmermann <theo.zimmermann@univ-paris-diderot.fr> | 2017-12-21 13:17:23 +0100 |
|---|---|---|
| committer | Théo Zimmermann <theo.zimmermann@univ-paris-diderot.fr> | 2017-12-21 13:17:23 +0100 |
| commit | 679227dced864d2855efaa2c3272dad847fb8b24 (patch) | |
| tree | f74876095e5c30ebca07131d468aae3251b5e9c4 | |
| parent | 2ded75b9b51aa9607cf2a123d6f8ae42a141e97a (diff) | |
Update README and CONTRIBUTING to mention the wiki and FAQ.
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 7 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b4e6a1418..37b556c55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,6 +48,8 @@ Our issue tracker includes a flag to mark bugs related to documentation. You can The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/refman/) are at [`doc/refman`](/doc/refman). These are written in LaTeX and compiled to HTML with [HeVeA](http://hevea.inria.fr/). +You may also contribute to the informal documentation available in [Cocorico](https://github.com/coq/coq/wiki) (the Coq wiki), and the [Coq FAQ](https://github.com/coq/coq/wiki/The-Coq-FAQ). Both of these are editable by anyone with a GitHub account. + ## Contributing outside this repository There are many useful ways to contribute to the Coq ecosystem that don't involve the Coq repository. @@ -16,9 +16,13 @@ read the [help page](https://coq.inria.fr/opam/www/using.html) on how to install or refer to the [`INSTALL` file](/INSTALL) for the procedure to install from source. ## Documentation -The documentation is part of the archive in directory doc. The + +The sources of the documentation can be found in directory [`doc`](/doc). The documentation of the last released version is available on the Coq web site at [coq.inria.fr/documentation](http://coq.inria.fr/documentation). +See also [Cocorico](https://github.com/coq/coq/wiki) (the Coq wiki), +and the [Coq FAQ](https://github.com/coq/coq/wiki/The-Coq-FAQ), +for additional user-contributed documentation. ## Changes There is a file named [`CHANGES`](/CHANGES) that explains the differences and the |