Skip to content

Commit

Permalink
Edit README
Browse files Browse the repository at this point in the history
See #116.

[skip ci]
  • Loading branch information
aantron committed Apr 16, 2018
1 parent ecc9be8 commit af59e44
Showing 1 changed file with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# odoc

**odoc** is a new documentation generator for OCaml. It includes an accurate
cross-referencer, which handles the complexity of the OCaml module system.
**odoc** is a documentation generator for OCaml. It reads *doc comments*,
delimited with `(** ... *)`, and outputs HTML. See example output at
[docs.mirage.io][mirage-docs].

odoc also offers a good opportunity to improve HTML output compared to ocamldoc,
but this is very much a work in progress :)
[mirage-docs]: http://docs.mirage.io/

Text inside doc comments is marked up in ocamldoc syntax:

```ocaml
val compare : string -> string -> int
(** [compare s1 s2] compares [s1] and [s2] in {e lexicographic} order. The
result is negative if [s1] precedes [s2], positive if [s1] follows [s2],
and zero if [s1] and [s2] are equal. *)
```

The syntax reference is [here][comment-syntax]. There is also an
[explanation][comment-location] of how to attach comments to specific types,
values, and other elements in your program.

[comment-syntax]: http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html#sec354
[comment-location]: http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html#sec350

<br/>

odoc's main advantage over ocamldoc is an accurate cross-referencer, which
handles the complexity of the OCaml module system. odoc also offers a good
opportunity to improve HTML output compared to ocamldoc, but this is very much
a work in progress :)

<br/>

Expand All @@ -31,9 +54,6 @@ The generated docs can then be found locally at
odoc is most discussed on [discuss.ocaml.org's Ecosystem category][discourse] with the `odoc` tag.
Please also don't hesitate to [open an issue][issues].

We may add a Gitter chat to the repo, or find some other way of communicating
that is more interactive :)

<br/>

## Contributing
Expand All @@ -44,9 +64,6 @@ you'd like to contribute code specifically, you may find the guide in
[`CONTRIBUTING.md`][contributing.md] helpful. If anything is missing from it,
please don't hesitate to [reach out](#contact) for help.

In the coming days, we will ask odoc users for a wishlist, and post a roadmap
based on it.

[discourse]: https://discuss.ocaml.org/c/eco
[issues]: https://github.com/ocaml/odoc/issues/new
[contributing.md]: https://github.com/ocaml/odoc/blob/master/CONTRIBUTING.md

0 comments on commit af59e44

Please sign in to comment.