From a6ff553210fc8ab6422fc7c5e1f8849ebb4b693e Mon Sep 17 00:00:00 2001 From: Anil Madhavapeddy Date: Mon, 16 Sep 2013 13:43:55 +0100 Subject: [PATCH] Markdown layout fixes, and note that OPAM installs the binary now Closes #1 and OCamlPro/opam-repository#1100 --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 27d5f42..d97737a 100644 --- a/README.md +++ b/README.md @@ -32,30 +32,34 @@ If you are using the OPAM package manager: these can be installed by: -opam install ocamlfind camlpdf +``` +opam install camlpdf +``` To build -------- -1. Type 'make' to make the cpdf executable and the library +1. Type `make` to make the cpdf executable and the library -2. Type 'make install' to install the OCaml cpdf library. +2. Type `make install` to install the OCaml cpdf library. -The cpdf executable should be manually placed somewhere suitable. +The `cpdf` executable should be manually placed somewhere suitable. -Alternatively, the library only can be installed by +Alternatively, the library and command-line binary can be installed by +``` opam install cpdf +``` + Documentation ------------- -The file cpdfmanual.pdf in this folder is the documentation for the command -line tools. The documentation for the cpdf OCaml library is in doc/html/cpdf/ +The file `cpdfmanual.pdf` in this folder is the documentation for the command +line tools. The documentation for the cpdf OCaml library is in `doc/html/cpdf/` in this folder once the library has been built. Contact ------- [contact@coherentgraphics.co.uk](contact@coherentgraphics.co.uk) -