Skip to content

Commit 5270a11

Browse files
author
Cristina Yenyxe Gonzalez Garcia
authored
Build instructions for macOS simplified
1 parent f523333 commit 5270a11

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

README.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -121,35 +121,24 @@ Binaries will be created in the `bin` subfolder.
121121

122122
### macOS
123123

124-
On macOS the binaries obtained with have system libraries dynamically linked. You won't need to install any dependencies to run vcf-validator.
124+
On macOS the binaries obtained will only have system libraries dynamically linked. This means you will need to install dependencies to build vcf-validator but not to run it.
125125

126126
#### Dependencies
127127

128-
You can easily install some of the required dependencies running `./install_dependencies.sh osx`, and you may run `./install_dependencies.sh --help` for help. Otherwise please follow the steps below.
128+
In order to compile this project, first you need to run `brew install cmake ninja boost sqlite3`.
129129

130-
##### Compression libraries
131-
132-
Pre-compiled static libraries for macOS are not available. You will require to build these from source to obitain static library files. You may simply use `install_dependencies.sh` to make these dependencies.
133-
134-
##### Boost
135-
136-
The dependencies are the Boost library core, and its submodules: Boost.filesystem, Boost.iostreams, Boost.program_options, Boost.regex, Boost.log and Boost.system. You can install them using `brew install boost`.
137-
138-
##### ODB
130+
Now you can easily install ODB ORM and compression libraries just by running `./install_dependencies.sh osx`. You may run `./install_dependencies.sh --help` for usage instructions.
139131

140-
You will need to download the ODB compiler, the ODB common runtime library, and the SQLite database runtime library from [this page](http://codesynthesis.com/products/odb/download.xhtml).
141-
142-
ODB requires SQLite3 to be installed, which you can do using `brew install sqlite3`.
143-
144-
Pre compiled binaries of ODB compiler for macOS are provided. Both the ODB runtime and SQLite database runtime libraries can be installed manually running `./configure && make && make install`. This will install the libraries in `/usr/local/lib`.
145-
146-
You may install ODB in some other location, please run `./configure --prefix=/path/to/odb/libraries/folder` to specify which folder to install ODB in, then `make && make install`. Also you will have to provide the path to ODB while configuring libodb-sqlite using `./configure --with-libodb=/path/to/odb/libraries`.
132+
Finally, add the `osx_dependencies/odb-2.4.0-i686-macosx/bin` subfolder to your PATH to be able to run the ODB compiler.
147133

148134
#### Compile
149135

150-
In order to create the build scripts, please run `cmake` with your preferred generator. For instance, `cmake -G "Unix Makefiles"` will create Makefiles, and to build the binaries, you will need to run `make`.
136+
In order to create the build scripts and compile vcf-validator, please run the following commands from the project root folder:
151137

152-
Please keep all the external libraries `libodb.a`, `libodb-sqlite.a`, `libbz2.a` and `libz.a` in the same directory. In case any of the libraries are installed in non-default location, the option `-DEXT_LIB_PATH=/path/to/external/libraries/folder` must be also provided to the `cmake` command.
138+
```
139+
cmake -DCMAKE_CXX_FLAGS="-Iosx_dependencies/libodb-2.4.0 -Iosx_dependencies/libodb-sqlite-2.4.0" -DCMAKE_EXE_LINKER_FLAGS="-Wl,-rpath,osx_dependencies/ -Losx_dependencies/" -DEXT_LIB_PATH=$PWD/osx_dependencies/ ./ -GNinja
140+
ninja -v -j2
141+
```
153142

154143
Binaries will be created in the `bin` subfolder.
155144

0 commit comments

Comments
 (0)