valitydev/yamerl
14
0
Fork 0
mirror of https://github.com/valitydev/yamerl.git synced 2024-11-06 02:45:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

installation.md now fits in 80 columns

Browse Source
This commit is contained in:
Jean-Sébastien Pédron 2014-07-15 16:41:08 +02:00
parent 80b6d41a0d
commit 48cd7e1f22
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/installation.md
View File

@ -22,7 +22,8 @@
autoreconf -vif
```
2. Enter the sources directory and run the usual configure/make/make install:
2. Enter the sources directory and run the usual configure/make/make
install:
```bash
./configure
@ -30,7 +31,8 @@
make install
```
The default installation path is your Erlang's distribution libraries directory.
The default installation path is your Erlang's distribution libraries
directory.
## Requirements
@ -38,14 +40,17 @@ The default installation path is your Erlang's distribution libraries directory.
If you're using Rebar:
* rebar
* awk (tested with FreeBSD's awk, mawk and gawk, should work with any flavor of Awk)
* awk (tested with FreeBSD's awk, mawk and gawk, should work with any
flavor of Awk)
* Erlang/OTP R14B02 or later
If you're using the Autotools:
* autoconf 2.64 or later
* automake 1.11 or later
* awk (tested with FreeBSD's awk, mawk and gawk, should work with any flavor of Awk)
* make (tested with FreeBSD's make and GNU make, should work with any flavor of make)
* awk (tested with FreeBSD's awk, mawk and gawk, should work with any
flavor of Awk)
* make (tested with FreeBSD's make and GNU make, should work with any
flavor of make)
* Erlang/OTP R14B02 or later
### Testsuite dependencies
@ -84,13 +89,15 @@ autoreconf -vif
#### Inside sources vs. outside sources
* The simplest method is to run the `configure` script from the sources directory:
* The simplest method is to run the `configure` script from the sources
directory:
```bash
./configure
```
* The **recommended method** is to run the `configure` script from a separate directory, in order to keep the sources directory clean:
* The **recommended method** is to run the `configure` script from a
separate directory, in order to keep the sources directory clean:
```bash
# Create and enter a separate directory.
@ -104,14 +111,18 @@ autoreconf -vif
#### Changing the install path
The default installation path is your Erlang's distribution libraries directory, as reported by `code:lib_dir()`. To install in a different directory (eg. because you do not have sufficient privileges), you can use the `--prefix` option:
The default installation path is your Erlang's distribution libraries
directory, as reported by `code:lib_dir()`. To install in a different
directory (eg. because you do not have sufficient privileges), you can
use the `--prefix` option:
```bash
.../configure --prefix=$HOME/my-erlang-apps
```
#### Using a non-default Erlang distribution
By default, the system Erlang distribution is used by querying `erl(1)` taken from the `$PATH`. You can specify another Erlang distribution:
By default, the system Erlang distribution is used by querying `erl(1)`
taken from the `$PATH`. You can specify another Erlang distribution:
* using the `--with-erlang` option to point to the Erlang root directory:
@ -132,7 +143,10 @@ Easy peasy Japanesey!
make
```
You can use multiple make jobs (ie. using the `-j` option). However Erlang modules are built using Erlang's `make` application. And, as of this writing (Erlang R15B03), this application doesn't build modules in parallel.
You can use multiple make jobs (ie. using the `-j` option). However
Erlang modules are built using Erlang's `make` application. And, as of
this writing (Erlang R15B03), this application doesn't build modules in
parallel.
## Installing