Skip to content

Commit

Permalink
Update INSTALL.md instructions (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-zw authored Apr 24, 2021
1 parent 68c8666 commit 3704bcb
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ We include the commands to install these dependencies for Ubuntu and Fedora belo
$ sudo yum install gcc-c++ cmake make git gmp-devel procps-ng-devel boost-devel libsodium-devel
```


### Dependencies Mac OS X

On Mac OS X, install GMP from MacPorts (`port install gmp`).

MacPorts does not write its libraries into standard system folders, so you
might need to explicitly provide the paths to the header files and libraries by
appending `CXXFLAGS=-I/opt/local/include LDFLAGS=-L/opt/local/lib` to the line
above.

### Setting up git submodules and building

Fetch dependencies from their GitHub repos:
Expand All @@ -43,28 +53,28 @@ Fetch dependencies from their GitHub repos:
$ git submodule init && git submodule update
```

To create the Makefile:
Create a `build` folder:

```bash
$ cmake .
$ mkdir build; cd build
```

Then, to compile the library, tests, and profiling harness, run this within the `libiop` directory:
To create the Makefile:

```bash
$ make
$ cmake ..
```

### Building on Mac OS X

On Mac OS X, install GMP from MacPorts (`port install gmp`). Then disable the
dependencies not easily supported under OS X, using:
Then, to compile the library, tests, and profiling harness, run this within the `libiop/build`
directory:

```bash
$ cmake -DWITH_PROCPS=OFF ..
$ make
```

MacPorts does not write its libraries into standard system folders, so you
might need to explicitly provide the paths to the header files and libraries by
appending `CXXFLAGS=-I/opt/local/include LDFLAGS=-L/opt/local/lib` to the line
above.
Build flags include:
| Flag | Value | Description |
| ---- | ----- | ----------- |
| NDEBUG | false | Enables debug mode. |
| WITH_PROCPS | ON | Enables `libprocps`, which is by default turned off since it is not supported on some systems such as MacOS. |
| -GNinja | | Builds with `Ninja` instead. |

0 comments on commit 3704bcb

Please sign in to comment.