blob: 7f7d0b66db82acc079b20c0d8087a0fc46966096 [file] [log] [blame]
Paul Bakker7cea7622009-07-11 19:48:38 +00001README for PolarSSL
2
3-- COMPILING
4There are currently three active build systems within the PolarSSL releases:
5 - Make
6 - CMake
7 - Microsoft Visual Studio
8
9The main system used for development is CMake. That system is always the most up-to-date. The others should reflect all changes present in the CMake build system, but some features are not ported there by default.
10
11--- Make
12In order to build the source using Make, just enter at the command line:
13make
14
Paul Bakker5d8d64e2009-10-04 15:15:34 +000015In order to run the tests, enter:
16make check
17
Paul Bakker7cea7622009-07-11 19:48:38 +000018--- CMake
19In order to build the source using CMake, just enter at the command line:
20cmake .
21make
22
23There are 3 different active build modes specified within the CMake buildsystem:
24 - Release
25 This generates the default code without any unnecessary information in the binary files.
26 - Debug
27 This generates debug information and disables optimization of the code.
28 - Coverage
29 This generates code coverage information in addition to debug information.
30
31Switching build modes in CMake is simple. For debug mode, enter at the command line:
32cmake -D CMAKE_BUILD_TYPE:String="Debug" .
33
Paul Bakker5d8d64e2009-10-04 15:15:34 +000034In order to run the tests, enter:
35make test
36
Paul Bakker7cea7622009-07-11 19:48:38 +000037--- Microsoft Visual Studio
38The build files for Microsoft Visual Studio are generated for Visual Studio 6.0 all future Visual Studio's should be able to open and use this older version of the build files.
39
40The workspace 'polarssl.dsw' contains all the basic projects needed to build the library and all the programs. The files in tests are not generated and compiled, as these need a perl environment as well.