Skip to content

Commit 22a876f

Browse files
author
Daniel Kroening
authored
Merge pull request diffblue#1523 from reuk/reuk/update-compiling-instructions
Update COMPILING with cmake setup instructions
2 parents 99592b3 + 8fe258b commit 22a876f

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

COMPILING.md

+29-10
Original file line numberDiff line numberDiff line change
@@ -164,16 +164,35 @@ There is an experimental build based on CMake instead of hand-written
164164
makefiles. It should work on a wider variety of systems than the standard
165165
makefile build, and can integrate better with IDEs and static-analysis tools.
166166
167-
1. Run `cmake --version`. If you get a command-not-found error, or the
168-
installed version is lower than 3.2, go and install a new version. Most
169-
Linux distributions have a package for CMake, and Mac users can get it
170-
through Homebrew. Windows users should download it manually from cmake.org.
171-
2. Create a directory to store your build:
172-
```
173-
mkdir build
174-
```
175-
Run this from the *top level* folder of the project. This is different from
176-
the other builds, which require you to `cd src` first.
167+
1. Ensure you have all the build dependencies installed. Build dependencies are
168+
the same as for the makefile build, but with the addition of CMake version
169+
3.2 or higher. The installed CMake version can be queried with `cmake
170+
--version`. To install all build dependencies:
171+
- On Debian-like distributions, do
172+
```
173+
apt-get install cmake g++ gcc flex bison make git libwww-perl patch
174+
```
175+
- On Red Hat/Fedora or derivates, do
176+
```
177+
yum install cmake gcc gcc-c++ flex bison perl-libwww-perl patch devtoolset-6
178+
```
179+
- On macOS, do
180+
```
181+
xcode-select --install
182+
```
183+
You shoud also install [Homebrew](https://brew.sh), after which you can
184+
run `brew install cmake` to install CMake.
185+
- On Windows, install Cygwin, then from the Cygwin setup facility install
186+
`cmake`, `flex`, `bison`, `tar`, `gzip`, `git`, `make`, `wget`, and
187+
`patch`.
188+
- Use of CMake has not been tested on Solaris or FreeBSD. However, it should
189+
be possible to install CMake from the system package manager or the
190+
[official download page](https://cmake.org/download) on those systems.
191+
The dependencies (as listed in the relevant sections above) will also be
192+
required, and should be installed using the suggested methods.
193+
2. Navigate to the *top level* folder of the project. This is different from
194+
the Makefile build, which requires you to navigate to the `src` directory
195+
first.
177196
3. Generate build files with CMake:
178197
```
179198
cmake -H. -Bbuild

0 commit comments

Comments
 (0)