8000 Update build_and_install.md · jinja2cpp/jinja2cpp.github.io@1fefcf2 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1fefcf2

Browse files
flexferrumflexferrum
authored
Update build_and_install.md
1 parent 518a585 commit 1fefcf2

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

‎docs/build_and_install.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@ In order to compile Jinja2C++ you need:
3636
1. Install CMake build system (at least version 3.0)
3737
2. Clone jinja2cpp repository and update submodules:
3838
```
39-
> git clone https://github.com/flexferrum/Jinja2Cpp.git
39+
> git clone https://github.com/jinja2cpp/Jinja2Cpp.git
40+
> cd Jinja2Cpp
4041
> git submodule -q update --init
4142
```
4243
3. Create build directory:
4344
```
44-
> cd Jinja2Cpp
45-
> mkdir build
45+
> mkdir .build
4646
```
4747
4. Run CMake and build the library:
4848
```
49-
> cd build
49+
> cd .build
5050
> cmake .. -DCMAKE_INSTALL_PREFIX=<path to install folder>
51-
> cmake --build . --target all
51+
> cmake --build . --target install
5252
```
5353
"Path to install folder" here is a path to the folder where you want to install Jinja2Cpp lib.
5454
5. Install library:
@@ -61,7 +61,7 @@ In order to compile Jinja2C++ you need:
6161
```
6262

6363
### Use with conan.io dependency manager
64-
Jinja2Cpp can be used as conan.io package. In this case you should do the following steps:
64+
Jinja2C++ can be used as conan.io package. In this case you should do the following steps:
6565

6666
1. Install conan.io according to the documentation ( https://docs.conan.io/en/latest/installation.html )
6767
2. Register the following remote conan.io repositories:
@@ -70,7 +70,7 @@ Jinja2Cpp can be used as conan.io package. In this case you should do the follow
7070
- https://api.bintray.com/conan/manu343726/conan-packages
7171

7272
The sample command is: `conan remote add martin https://api.bintray.com/conan/martinmoene/nonstd-lite`
73-
3. Add reference to Jinja2Cpp package (`jinja2cpp/0.9.1@Manu343726/testing`) to your conanfile.txt, conanfile.py or CMakeLists.txt. For instance, with usage of `conan-cmake` integration it could be written this way:
73+
3. Add reference to Jinja2C++ package (`jinja2cpp/0.9.1@Manu343726/testing`) to your conanfile.txt, conanfile.py or CMakeLists.txt. For instance, with usage of `conan-cmake` integration it could be written this way:
7474

7575
```cmake
7676
include (../../cmake/conan.cmake)
@@ -102,25 +102,25 @@ set_target_properties (${TARGET_NAME} PROPERTIES
102102
### Additional CMake build flags
103103
You can define (via -D command line CMake option) the following build flags:
104104

105-
- **JINJA2CPP_BUILD_TESTS** (default TRUE) - to build or not to Jinja2Cpp tests.
105+
- **JINJA2CPP_BUILD_TESTS** (default TRUE) - to build or not to Jinja2C++ tests.
106106
- **JINJA2CPP_STRICT_WARNINGS** (default TRUE) - Enable strict mode compile-warnings(-Wall -Werror and etc).
107-
- **JINJA2CPP_BUILD_SHARED** (default OFF) - Specify Jinja2Cpp library library link type.
107+
- **JINJA2CPP_BUILD_SHARED** (default OFF) - Specify Jinja2C++ library library link type.
108108
- **MSVC_RUNTIME_TYPE** (default /MD) - MSVC runtime type to link with (if you use Microsoft Visual Studio compiler).
109109
- **JINJA2CPP_DEPS_MODE** (default "internal") - modes for dependencies handling. Following values possible:
110-
- `internal` In this mode Jinja2Cpp build script uses dependencies (include `boost`) shipped as subprojects. Nothing needs to be provided externally.
111-
- `external-boost` In this mode Jinja2Cpp build script uses only `boost` as externally-provided dependency. All other dependencies taken from subprojects.
110+
- `internal` In this mode Jinja2C++ build script uses dependencies (include `boost`) shipped as subprojects. Nothing needs to be provided externally.
111+
- `external-boost` In this mode Jinja2C++ build script uses only `boost` as externally-provided dependency. All other dependencies taken from subprojects.
112112
- `external` In this mode all dependencies should be provided externally. Paths to `boost`, `nonstd-*` libs etc. should be specified via standard CMake variables (like `CMAKE_PREFIX_PATH` or libname_DIR)
113-
- `conan-build` Special mode for building Jinja2Cpp via conan recipe.
113+
- `conan-build` Special mode for building Jinja2C++ via conan recipe.
114114

115115
## Dependency management modes
116116
TODO:
117117

118118
## Link with you projects
119-
Jinja2Cpp is shipped with cmake finder script. So you can:
119+
Jinja2C++ is shipped with cmake finder scripts. So you can:
120120

121-
1. Include Jinja2Cpp cmake scripts to the project:
121+
1. Include Jinja2C++ cmake scripts to the project:
122122
```cmake
123-
list (APPEND CMAKE_MODULE_PATH ${JINJA2CPP_INSTALL_DIR}/cmake)
123+
list (APPEND CMAKE_MODULE_PATH ${JINJA2CPP_INSTALL_DIR}/lib/jinja2cpp)
124124
```
125125
2. Use regular 'find' script:
126126
```cmake

0 commit comments

Comments
 (0)
0