Commit 352264fa authored by POTTIER Francois's avatar POTTIER Francois
Browse files

Convert INSTALLATION.md to markdown.

parent 9fae2e10
------------------------------------------------------------------------------
REQUIREMENTS
## Requirements
You need OCaml 4.02 or later, ocamlbuild, and GNU make.
------------------------------------------------------------------------------
CONFIGURATION CHOICES
## Configuration Choices
1- PREFIX
### `PREFIX`
The value of the PREFIX variable can be changed to control where the software,
The value of the `PREFIX` variable can be changed to control where the software,
the standard library, and the documentation are stored. These files are copied
to the following places:
```
$PREFIX/bin/
$PREFIX/share/menhir/
$PREFIX/doc/menhir/
```
PREFIX must be set when invoking "make all" and "make install" (see below).
2- USE_OCAMLFIND
`PREFIX` must be set when invoking `make all` and `make install` (see below).
The support libraries, MenhirLib and MenhirSdk, are installed either via
ocamlfind or directly in the directory $PREFIX/share/menhir. Installing via
ocamlfind is recommended (and is the default). It requires the "ocamlfind"
executable to be found in the PATH. An explicit choice can be made by setting
USE_OCAMLFIND to "true" or "false" when running "make all" (see below).
### `USE_OCAMLFIND`
3- TARGET
The support libraries, `MenhirLib` and `MenhirSdk`, are installed either via
ocamlfind or directly in the directory `$PREFIX/share/menhir`. Installing via
ocamlfind is recommended (and is the default). It requires the `ocamlfind`
executable to be found in the `PATH`. An explicit choice can be made by setting
`USE_OCAMLFIND` to `true` or `false` when running `make all` (see below).
If your machine does not have the native code OCaml compiler (ocamlopt), but
does have the bytecode compiler (ocamlc), then you should define "TARGET=byte"
when running "make all" and "make install".
### `TARGET`
------------------------------------------------------------------------------
If your machine does not have the native code OCaml compiler (`ocamlopt`), but
does have the bytecode compiler (`ocamlc`), then you should define `TARGET=byte`
when running `make all` and `make install`.
COMPILATION & INSTALLATION
## Compilation And Installation
Compile and install as follows:
```
make PREFIX=/usr/local USE_OCAMLFIND=true all
sudo make PREFIX=/usr/local install
```
(If necessary, adjust PREFIX, USE_OCAMLFIND and TARGET as described above.)
(If necessary, adjust `PREFIX`, `USE_OCAMLFIND` and `TARGET` as described above.)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment