Skip to content

Commit 33f8a37

Browse files
committed
CMake: Add documentation to README.md
1 parent 4c543bb commit 33f8a37

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,30 @@ This repository uses a submodule to pull in my [Free GetOpt](https://github.com/
1515

1616
1. Clone this repository and `cd` into it.
1717
2. Run `git submodule update --init`
18-
3. If you're working on a Unix system, run `autoreconf -i`
18+
3. There are two ways to build VBinDiff: using [Autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html) or using [CMake](https://cmake.org/)
19+
* Autotools:
20+
* If you're working on a Unix system, run `autoreconf -i`
21+
* Now you're ready to use the normal `./configure && make` process on Unix, or open `win32/vbindiff.dsw` on Windows.
22+
* CMake:
23+
* Example usage on Unix-like systems (including Windows with MinGW):
24+
```
25+
mkdir build
26+
cd build
27+
cmake ..
28+
make
29+
```
30+
Try also `ccmake ..` or `cmake-gui ..` in place of `cmake ..` above.
31+
* Windows / Visual Studio: See [CMake support in Visual Studio](https://blogs.msdn.microsoft.com/vcblog/2016/10/05/cmake-support-in-visual-studio/) or use the same approach as on Unix-like systems and then open the generated project file:
32+
```
33+
mkdir build
34+
cd build
35+
cmake -G "Visual Studio 15 2017 Win64" ..
36+
```
37+
Now open the generated project file in Visual Studio.
38+
See [cmake-generators(7)](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#visual-studio-generators) for the list of available generators / supported Visual Studio versions.
39+
40+
1941
20-
Now you're ready to use the normal `./configure && make` process on Unix, or open `win32/vbindiff.dsw` on Windows.
2142
2243
To build the documentation, you'll also need [Perl](https://www.perl.org/), [Date::Format](https://metacpan.org/module/Date::Format), and [Template-Toolkit](https://metacpan.org/release/Template-Toolkit). For Windows, I recommend [Strawberry Perl](http://strawberryperl.com/), which comes with the necessary modules. On Unix, your distro may have packages, or you can install from [CPAN](https://metacpan.org/). Package names for some distros are:
2344

0 commit comments

Comments
 (0)