Permalink
Browse files

clean up dox

  • Loading branch information...
1 parent 04826e9 commit 755319cf37343e51d260ff69c0a9b33c3c403bc9 @wickedchicken wickedchicken committed Oct 4, 2011
Showing with 7 additions and 3 deletions.
  1. +7 −3 README.md
View
@@ -1,6 +1,10 @@
ocaml skeleton
==============
+`ocaml_skeleton` is a scaffolding framework to get up and running build OCaml
+applications quickly. It provides a filesystem structure, Makefile, and example
+unit tests.
+
OCaml is relatively difficult to navigate as a new user. While the language has
ample online documentation, the development environment itself can be remarkably
opaque. The problem is compounded by numerous sites providing half-working
@@ -41,7 +45,7 @@ usage
The `Makefile` contains 5 targets: `main-native`, `main`, `tests-native`, `tests`, and
`clean`. `-native` are natively compiled (but not necessarily optimized)
versions of the binaries while the others are byte-code versions. Binaries are
-copied into bin/ after being build with `ocamlbuild`.
+copied into bin/ after being built with `ocamlbuild`.
In short:
@@ -74,8 +78,8 @@ or `pkg_num`.
*Note*: there is a bug related to this, look in the bugs section if you want to
add a package to `main.ml` or `tests.ml`.
-Tests are written in `tests/tests.ml`. Make sure OUnit is opened, open up your
-module, and write some tests using the
+Tests are written in `tests/tests.ml`. Make sure the `OUnit` package is opened,
+open up your module, and write some tests using the
[OUnit](http://ounit.forge.ocamlcore.org/api) framework. For a reference, here
is a list of [available testing
methods](http://ounit.forge.ocamlcore.org/api/OUnit.html). Note that you must

0 comments on commit 755319c

Please sign in to comment.