Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

clean up dox

  • Loading branch information...
commit 755319cf37343e51d260ff69c0a9b33c3c403bc9 1 parent 04826e9
Mike Stipicevic authored October 03, 2011

Showing 1 changed file with 7 additions and 3 deletions. Show diff stats Hide diff stats

  1. 10  README.md
10  README.md
Source Rendered
... ...
@@ -1,6 +1,10 @@
1 1
 ocaml skeleton
2 2
 ==============
3 3
 
  4
+`ocaml_skeleton` is a scaffolding framework to get up and running build OCaml
  5
+applications quickly. It provides a filesystem structure, Makefile, and example
  6
+unit tests.
  7
+
4 8
 OCaml is relatively difficult to navigate as a new user. While the language has
5 9
 ample online documentation, the development environment itself can be remarkably
6 10
 opaque. The problem is compounded by numerous sites providing half-working
@@ -41,7 +45,7 @@ usage
41 45
 The `Makefile` contains 5 targets: `main-native`, `main`, `tests-native`, `tests`, and
42 46
 `clean`. `-native` are natively compiled (but not necessarily optimized)
43 47
 versions of the binaries while the others are byte-code versions. Binaries are
44  
-copied into bin/ after being build with `ocamlbuild`.
  48
+copied into bin/ after being built with `ocamlbuild`.
45 49
 
46 50
 In short:
47 51
 
@@ -74,8 +78,8 @@ or `pkg_num`.
74 78
 *Note*: there is a bug related to this, look in the bugs section if you want to
75 79
 add a package to `main.ml` or `tests.ml`.
76 80
 
77  
-Tests are written in `tests/tests.ml`. Make sure OUnit is opened, open up your
78  
-module, and write some tests using the
  81
+Tests are written in `tests/tests.ml`. Make sure the `OUnit` package is opened,
  82
+open up your module, and write some tests using the
79 83
 [OUnit](http://ounit.forge.ocamlcore.org/api) framework. For a reference, here
80 84
 is a list of [available testing
81 85
 methods](http://ounit.forge.ocamlcore.org/api/OUnit.html).  Note that you must

0 notes on commit 755319c

Please sign in to comment.
Something went wrong with that request. Please try again.