aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Guillaume Claret <dev@clarus.me>2015-08-05 16:16:13 +0200
committerGravatar Guillaume Claret <dev@clarus.me>2015-08-05 16:16:13 +0200
commit62ca663881ac7f731e2cf8a574c2e615f8d4a900 (patch)
treea7bc889525f12cf0d0550e71ad22fcb97b27fb44
parente76ab0ec81040cbe99f616e8457bdc26cc6dceb6 (diff)
README in MarkDown
-rw-r--r--README66
-rw-r--r--README.md41
2 files changed, 41 insertions, 66 deletions
diff --git a/README b/README
deleted file mode 100644
index 293ee4c8f..000000000
--- a/README
+++ /dev/null
@@ -1,66 +0,0 @@
-
- THE COQ V8 SYSTEM
- =================
-
-INSTALLATION.
-=============
-
- See the file INSTALL for installation procedure.
-
-
-DOCUMENTATION.
-==============
-
- The documentation is part of the archive in directory doc. The
- documentation of the last released version is available on the Coq
- web site at http://coq.inria.fr/doc.
-
-
-CHANGES.
-========
-
- There is a file named CHANGES that explains the differences and the
- incompatibilities since last versions. If you upgrade Coq, please read
- it carefully.
-
-
-AVAILABILITY.
-=============
-
- Coq is available from http://coq.inria.fr.
-
-
-THE COQ CLUB.
-=============
-
- The Coq Club moderated mailing list is meant to be a standard way
- to discuss questions about the Coq system and related topics. The
- subscription link can be found at http://coq.inria.fr/community.
-
- The topics to be discussed in the club should include:
-
- * technical problems;
-
- * questions about proof developments;
-
- * suggestions and questions about the implementation;
-
- * announcements of proofs;
-
- * theoretical questions about typed lambda-calculi which are
- closely related to Coq.
-
- For any questions/suggestions about the Coq Club, please write to
- coq-club-request@inria.fr.
-
-
-BUGS REPORT.
-============
-
- Send your bug reports by filling a form at
-
- http://coq.inria.fr/bugs
-
- To be effective, bug reports should mention the Caml version used
- to compile and run Coq, the Coq version (coqtop -v), the configuration
- used, and include a complete source example leading to the bug.
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..3c9ebcb3f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# THE COQ V8 SYSTEM
+
+## INSTALLATION
+See the file `INSTALL` for installation procedure.
+
+## DOCUMENTATION
+The documentation is part of the archive in directory doc. The
+documentation of the last released version is available on the Coq
+web site at [coq.inria.fr/doc](http://coq.inria.fr/doc).
+
+## CHANGES
+There is a file named `CHANGES` that explains the differences and the
+incompatibilities since last versions. If you upgrade Coq, please read
+it carefully.
+
+## AVAILABILITY
+Coq is available from [coq.inria.fr](http://coq.inria.fr).
+
+## THE COQ CLUB
+The Coq Club moderated mailing list is meant to be a standard way
+to discuss questions about the Coq system and related topics. The
+subscription link can be found at [coq.inria.fr/community](http://coq.inria.fr/community).
+
+The topics to be discussed in the club should include:
+
+* technical problems;
+* questions about proof developments;
+* suggestions and questions about the implementation;
+* announcements of proofs;
+* theoretical questions about typed lambda-calculi which are
+ closely related to Coq.
+
+For any questions/suggestions about the Coq Club, please write to
+`coq-club-request@inria.fr`.
+
+## BUGS REPORT
+Send your bug reports by filling a form at [coq.inria.fr/bugs](http://coq.inria.fr/bugs).
+
+To be effective, bug reports should mention the OCaml version used
+to compile and run Coq, the Coq version (`coqtop -v`), the configuration
+used, and include a complete source example leading to the bug.