Skip to content

Commit fa7234e

Browse files
committed
Updating build documentation
1 parent 9fed938 commit fa7234e

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ to build the `librabbitmq` library and the example programs.
4747

4848
# Using cmake
4949

50-
You will not need to clone the codegen repository, the build system
51-
will do it for you. You will however need a working python install,
52-
you will also need git installed
50+
You will need CMake http://cmake.org/
51+
You will need a working python install in your path.
52+
If you would like the build system to fetch the rabbitmq-codegen automatically
53+
you will need to have a working git install in your path. Otherwise you will
54+
need to checkout the rabbitmq-codegen as stated above.
5355

5456
Create a binary directory in a sibling directory from the directory
5557
you cloned the rabbitmq-c repository
@@ -62,6 +64,22 @@ Build it
6264
On linux: make
6365
On win32: nmake or msbuild, or open it in visual studio and build from there
6466

67+
Things you can pass to cmake to change the build:
68+
69+
-DRABBITMQ_CODEGEN_DIR=/path/to/rabbitmq-codegen/checkout - if you have your codegen
70+
directory in a different place [Default is sibiling directory to source]
71+
-DFETCH_CODEGEN_FROM_GIT=ON - if you want cmake to fetch the rabbitmq-codegen from
72+
https://github.com/rabbitmq/rabbitmq-c at build time. If this option is selected
73+
-DRABBITMQ_CODEGEN_DIR will be ignored [Default is off]
74+
-DCODEGEN_GIT_TAG=rabbitmq_v2_5_1 - specifies the tag to check out if using the
75+
-DFETCH_CODEGEN_FROM_GIT option above. [Default is rabbitmq_v2_5_1]
76+
-DBUILD_TOOLS=OFF build the programs in the tools directory
77+
[Default is ON if the POPT library can be found]
78+
79+
Other interesting flags to pass to CMake (see cmake docs for more info)
80+
-DCMAKE_BUILD_TYPE - specify the type of build (Debug or Release)
81+
-DCMAKE_INSTALL_PREFIX - specify where the install target puts files
82+
6583
## Running the examples
6684

6785
Arrange for a RabbitMQ or other AMQP server to be running on

0 commit comments

Comments
 (0)