Commit f723f675 authored by Stephane Glondu's avatar Stephane Glondu
Browse files

Update INSTALL

 * more comprehensive list of system prerequisites
 * update opam-bootstrap.sh documentation
parent 0ee309d8
...@@ -10,16 +10,28 @@ compile Belenios from source is to use ...@@ -10,16 +10,28 @@ compile Belenios from source is to use
[OPAM](http://opam.ocamlpro.com/), which is a package manager for [OPAM](http://opam.ocamlpro.com/), which is a package manager for
OCaml projects. OCaml projects.
The requirements are a POSIX system, a C compiler, The non-OCaml prerequisites are:
[GMP](http://gmplib.org/) and [PCRE](http://www.pcre.org/). These
libraries are quite common, and probably available from your system
package manager if you have one.
In Belenios sources, there is a `opam-bootstrap.sh` shell script that * a POSIX system with a C compiler
downloads and installs OCaml, OPAM and all the dependencies of * [GMP](http://gmplib.org/)
Belenios into a single directory. You can chose the directory by * [PCRE](http://www.pcre.org/)
setting the `OPAMROOT` environment variable, or it will take `~/.opam` * [pkg-config](http://www.freedesktop.org/wiki/Software/pkg-config/)
by default. Just run: * [m4](https://www.gnu.org/software/m4/)
* [SQLite3](https://www.sqlite.org/)
* [OpenSSL](https://www.openssl.org/)
These libraries and tools are pretty common, and might be directly part
of your operating system. On [Debian](http://www.debian.org/) and its
derivatives, they can be installed with the following command:
apt-get install build-essential libgmp-dev libpcre3-dev pkg-config m4 libssl-dev libsqlite3-dev
If you are unfamiliar with OCaml or OPAM, we provide an
`opam-bootstrap.sh` shell script that creates a whole, hopefully
self-contained, OCaml+OPAM install, and then installs all the
dependencies of Belenios, everything into a single directory. You can
chose the directory by setting the `BELENIOS_SYSROOT` environment
variable, or it will take `~/.belenios` by default. Just run:
./opam-boostap.sh ./opam-boostap.sh
...@@ -33,6 +45,10 @@ update your shell environment, then run: ...@@ -33,6 +45,10 @@ update your shell environment, then run:
and you can skip the next two sections. and you can skip the next two sections.
If you are familiar with OCaml, please read the `opam-bootstrap.sh`
shell script, or the following two sections to compile Belenios with
your existing OCaml installation.
Command-line tool Command-line tool
----------------- -----------------
......
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