cuberite/SQLiteCpp
1
0
Fork 0
mirror of https://github.com/cuberite/SQLiteCpp.git synced 2025-08-04 17:56:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix #66: Update documentation on installation, CMake and unit tests

Browse Source
This commit is contained in:
Sébastien Rombauts 2015-09-06 12:31:05 +02:00
parent 2c62e9595c
commit f39b84c879
1 changed files with 38 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -80,30 +80,51 @@ Thus this SQLiteCpp repository can directly be used as a Git submoldule.
Under Debian/Ubuntu/Mint Linux, install the libsqlite3-dev package. Under Debian/Ubuntu/Mint Linux, install the libsqlite3-dev package.
### Building the examples: ### Building examples and unit-tests:
#### CMake and test Use git to clone the repository. Then init and update submodule "googletest".
A CMake configuration file is also provided for multiplatform support and testing.
Typical generic build (see also "build.bat" or "./build.sh"): ```Shell
git clone https://github.com/SRombauts/SQLiteCpp.git
```bash cd SQLiteCpp
mkdir build git submodule init
cd build git submodule update
cmake .. # cmake .. -G "Visual Studio 10" # for Visual Studio 2010
cmake --build . # make
ctest . # make test
``` ```
Generating the Linux Makefile, building in Debug and executing the tests: #### CMake and tests
A CMake configuration file is also provided for multiplatform support and testing.
```bash Typical generic build for MS Visual Studio under Windows (from [build.bat](build.bat)):
```Batchfile
mkdir build
cd build
cmake .. # cmake .. -G "Visual Studio 10" # for Visual Studio 2010
@REM Generate a Visual Studio solution for latest version found
cmake -DSQLITECPP_BUILD_EXAMPLES=ON -DSQLITECPP_BUILD_TESTS=ON ..
@REM Build default configuration (ie 'Debug')
cmake --build .
@REM Build and run tests
ctest --output-on-failure
```
Generating the Linux Makefile, building in Debug and executing the tests (from [build.sh](build.sh)):
```Shell
mkdir Debug mkdir Debug
cd Debug cd Debug
cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake --build . # make # Generate a Makefile for GCC (or Clang, depanding on CC/CXX envvar)
ln -s ../examples examples cmake -DSQLITECPP_BUILD_EXAMPLES=ON -DSQLITECPP_BUILD_TESTS=ON ..
ctest . # make test
# Build (ie 'make')
cmake --build .
# Build and run unit-tests (ie 'make test')
ctest --output-on-failure
``` ```
#### CMake options #### CMake options