Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
642ad3d
commit bebc9fe
Showing
2 changed files
with
23 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,20 @@ | ||
# vstyle: A style guide for Coq | ||
|
||
![GitHub](https://img.shields.io/github/license/appliedfm/vstyle) | ||
[![Contributing](https://img.shields.io/badge/-contribute-success.svg)](https://github.com/appliedfm/vstyle/blob/main/CONTRIBUTING.md) | ||
[![applied.fm](https://img.shields.io/badge/-applied.fm-orchid)](https://applied.fm) | ||
|
||
![Website](https://img.shields.io/website?url=https%3A%2F%2Fvstyle.readthedocs.io) | ||
![Documentation Status](https://readthedocs.org/projects/vstyle/badge/?version=latest) | ||
|
||
![GitHub](https://img.shields.io/github/license/appliedfm/vstyle) | ||
[![Contributing](https://img.shields.io/badge/-contribute-success.svg)](https://github.com/appliedfm/vstyle/blob/main/CONTRIBUTING.md) | ||
|
||
The latest version can be viewed at [vstyle.readthedocs.io](https://vstyle.readthedocs.io). | ||
|
||
Published by [applied.fm](https://applied.fm). Hosted by [readthedocs.org](https://readthedocs.org/projects/vstyle/). | ||
|
||
|
||
## Building | ||
# | ||
|
||
[![Coq](https://img.shields.io/badge/-Coq-royalblue)](https://github.com/coq/coq) | ||
[![Alectryon](https://img.shields.io/badge/-Alectryon-orangered)](https://github.com/cpitclaudel/alectryon/) | ||
[![Sphinx](https://img.shields.io/badge/-Sphinx-navy)](https://www.sphinx-doc.org) | ||
[![readthedocs](https://img.shields.io/badge/-readthedocs-slateblue)](https://readthedocs.org) | ||
|
||
Requires: | ||
* [Sphinx](https://www.sphinx-doc.org) | ||
* [alectryon](https://github.com/cpitclaudel/alectryon) | ||
|
||
```console | ||
$ make -C docs html | ||
``` | ||
|
||
|
||
## References | ||
|
||
* [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) | ||
[![applied.fm](https://img.shields.io/badge/-applied.fm-orchid)](https://applied.fm) |