Permalink
Browse files

Added a Makefile, INSTALL instructions and a link to the ocamldoc

HTML documentation.
  • Loading branch information...
1 parent 28b483f commit e641cc442446af2322b009e5726ddc014a8d54fc @mjambon mjambon committed Nov 30, 2011
Showing with 56 additions and 6 deletions.
  1. +15 −0 INSTALL
  2. +29 −0 Makefile
  3. +7 −4 OMakefile
  4. +4 −2 README.md
  5. +1 −0 VERSION
View
15 INSTALL
@@ -0,0 +1,15 @@
+Building Nproc requires the following tools:
+
+- Make (command: make)
+- OCaml (command: ocamlc, ocamlopt)
+- Findlib (command: ocamlfind)
+- Lwt (check: ocamlfind list | grep lwt)
+
+Installation:
+
+ $ make
+ $ make install
+
+Uninstallation:
+
+ $ make uninstall
View
@@ -0,0 +1,29 @@
+# This Makefile provides only what is needed to build and install nproc.
+# Development is done with omake using the OMakefile.
+
+.PHONY: default all opt install uninstall
+
+default: all opt
+
+META: META.in VERSION
+ echo "version = \"$$(cat VERSION)\"" > META
+ cat META.in >> META
+
+all: META
+ ocamlfind ocamlc -c nproc.mli -package lwt.unix
+ ocamlfind ocamlc -a -g nproc.ml -o nproc.cma -package lwt.unix
+opt: META
+ ocamlfind ocamlc -c nproc.mli -package lwt.unix
+ ocamlfind ocamlopt -a -g nproc.ml -o nproc.cmxa -package lwt.unix
+install:
+ ocamlfind install nproc META \
+ `find nproc.mli nproc.cmi \
+ nproc.cmo nproc.cma \
+ nproc.cmx nproc.o nproc.cmxa nproc.a`
+uninstall:
+ ocamlfind remove nproc
+
+.PHONY: clean
+clean:
+ omake clean
+ rm -f *.omc
View
@@ -1,5 +1,3 @@
-VERSION = 0.5.0
-
USE_OCAMLFIND = true
BYTE_ENABLED = true
OCAMLDEP_MODULES_ENABLED = false
@@ -16,8 +14,8 @@ OCamlProgram(test_nproc, $(FILES) test_nproc)
.DEFAULT: META nproc.cma nproc.cmxa test_nproc.opt
-META: META.in OMakefile
- echo 'version = "$(VERSION)"' > META
+META: META.in VERSION
+ echo "version = \"$$(cat VERSION)\"" > META
cat META.in >> META
.PHONY: test
@@ -39,6 +37,11 @@ doc/index.html: $(MLI)
mkdir -p doc
ocamlfind ocamldoc -d doc -html $(MLI) -package $(OCAMLPACKS)
+.PHONY: install-doc
+install-doc: doc
+ cd ../mylifelabs.github.com && mkdir -p nproc
+ cp doc/* ../mylifelabs.github.com/nproc
+
.PHONY: clean
clean:
rm -f *.o *.a *.cm* *~ *.annot *.run *.opt test_nproc META doc/*
View
@@ -24,6 +24,8 @@ Performance status:
Throughput was 50K records per second, using a granularity of 100
records per task.
-
Do not hesitate to submit experience reports, either good or bad,
-and interface suggestions before it is too late.
+and [interface]{http://mylifelabs.github.com/nproc/Nproc.html}
+suggestions before it is too late.
+
+[Documentation]{http://mylifelabs.github.com/nproc/Nproc.html}
View
@@ -0,0 +1 @@
+0.5.0

0 comments on commit e641cc4

Please sign in to comment.