Skip to content

Commit 4393211

Browse files
committed
Update README.md
* fix links * update version tags
1 parent 17fe19b commit 4393211

File tree

2 files changed

+62
-18
lines changed

2 files changed

+62
-18
lines changed

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.23.0)
2-
project(Jinja2Cpp VERSION 1.3.0)
2+
project(Jinja2Cpp VERSION 1.3.1)
33

44
if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
55
set(JINJA2CPP_IS_MAIN_PROJECT TRUE)

README.md

+61-17
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Hello World!!!
9090

9191
That's all!
9292

93-
More detailed examples and features description can be found in the documentation: [https://jinja2cpp.dev/docs/usage](https://jinja2cpp.github.io/docs/usage)
93+
More detailed examples and features description can be found in the documentation: [https://jinja2cpp.github.io/docs/usage](https://jinja2cpp.github.io/docs/usage)
9494

9595
## Current Jinja2 support
9696
Currently, Jinja2C++ supports the limited number of Jinja2 features. By the way, Jinja2C++ is planned to be a fully [jinja2 specification](http://jinja.pocoo.org/docs/2.10/templates/)-conformant. The current support is limited to:
@@ -111,7 +111,7 @@ Currently, Jinja2C++ supports the limited number of Jinja2 features. By the way,
111111
- recursive loops
112112
- space control and 'raw'/'endraw' blocks
113113

114-
Full information about Jinja2 specification support and compatibility table can be found here: [https://jinja2cpp.dev/docs/j2_compatibility.html](https://jinja2cpp.github.io/docs/j2_compatibility.html).
114+
Full information about Jinja2 specification support and compatibility table can be found here: [https://jinja2cpp.github.io/docs/j2_compatibility.html](https://jinja2cpp.github.io/docs/j2_compatibility.html).
115115

116116
## Supported compilers
117117
Compilation of Jinja2C++ tested on the following compilers (with C++14 and C++17 enabled features):
@@ -134,10 +134,10 @@ Compilation of Jinja2C++ tested on the following compilers (with C++14 and C++17
134134
| **X-Code** 9, 10, 11 | [![Build Status](https://travis-ci.org/jinja2cpp/Jinja2Cpp.svg?branch=master)](https://travis-ci.org/jinja2cpp/Jinja2Cpp) |
135135
| **MSVC** 2017 (x86, x64), **MSVC** 2019 (x86, x64), C++14/C++17 | [![](https://github.com/jinja2cpp/Jinja2Cpp/workflows/CI-windows-build/badge.svg)](https://github.com/jinja2cpp/Jinja2Cpp/actions?query=workflow%3ACI-windows-build) |
136136
| **g++** 5, 6, 7, 8, 9, 10, 11 **clang** 5, 6, 7, 8, 9, 10, 11, 12 C++14/C++17/C++20 | [![](https://github.com/jinja2cpp/Jinja2Cpp/workflows/CI-linux-build/badge.svg)](https://github.com/jinja2cpp/Jinja2Cpp/actions?query=workflow%3ACI-linux-build) |
137-
137+
138138
## Build and install
139139
Jinja2C++ has several external dependencies:
140-
- `boost` library (at least version 1.65)
140+
- `boost` library (at least version 1.65)
141141
- `nonstd::expected-lite` [https://github.com/martinmoene/expected-lite](https://github.com/martinmoene/expected-lite)
142142
- `nonstd::variant-lite` [https://github.com/martinmoene/variant-lite](https://github.com/martinmoene/variant-lite)
143143
- `nonstd::optional-lite` [https://github.com/martinmoene/optional-lite](https://github.com/martinmoene/optional-lite)
@@ -182,24 +182,37 @@ In this case, Jinja2C++ will be built with internally-shipped dependencies and i
182182
Jinja2C++ can be used as conan.io package. In this case, you should do the following steps:
183183

184184
1. Install conan.io according to the documentation ( https://docs.conan.io/en/latest/installation.html )
185-
2. Add a reference to Jinja2C++ package (`jinja2cpp/1.1.0`) to your conanfile.txt, conanfile.py or CMakeLists.txt. For instance, with the usage of `conan-cmake` integration it could be written this way:
185+
2. Add a reference to Jinja2C++ package (`jinja2cpp/1.2.1`) to your conanfile.txt, conanfile.py or CMakeLists.txt. For instance, with the usage of `conan-cmake` integration it could be written this way:
186186

187187
```cmake
188-
include (../../cmake/conan.cmake)
189-
if (NOT MSVC)
190-
set (CONAN_SETTINGS SETTINGS compiler.libcxx=libstdc++11)
191-
endif ()
192188
193-
conan_cmake_run(REQUIRES
189+
cmake_minimum_required(VERSION 3.24)
190+
project(Jinja2CppSampleConan CXX)
191+
192+
list(APPEND CMAKE_MODULE_PATH ${CMAKE_BINARY_DIR})
193+
list(APPEND CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR})
194+
195+
add_definitions("-std=c++14")
196+
197+
if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
198+
message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
199+
file(DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/0.18.1/conan.cmake"
200+
"${CMAKE_BINARY_DIR}/conan.cmake"
201+
TLS_VERIFY ON)
202+
endif()
203+
include(${CMAKE_BINARY_DIR}/conan.cmake)
204+
205+
conan_cmake_autodetect(settings)
206+
conan_cmake_run(REQUIRES
194207
jinja2cpp/1.1.0
195-
gtest/1.7.0@bincrafters/stable
208+
gtest/1.14.0
196209
BASIC_SETUP
197210
${CONAN_SETTINGS}
198-
OPTIONS
199-
jinja2cpp:shared=False
200-
gtest:shared=False
211+
OPTIONS
212+
jinja2cpp/*:shared=False
213+
gtest/*:shared=False
201214
BUILD missing)
202-
215+
203216
set (TARGET_NAME jinja2cpp_build_test)
204217
205218
add_executable (${TARGET_NAME} main.cpp)
@@ -229,6 +242,8 @@ You can define (via -D command-line CMake option) the following build flags:
229242
Jinja2C++ tries to use standard versions of `std::variant`, `std::string_view` and `std::optional` if possible.
230243

231244
## Acknowledgments
245+
Thanks to **@flexferrum** for creating this library, for being one of the brightest minds in software engineering community. Rest in peace, friend.
246+
232247
Thanks to **@manu343726** for CMake scripts improvement, bug hunting, and fixing and conan.io packaging.
233248

234249
Thanks to **@martinmoene** for the perfectly implemented xxx-lite libraries.
@@ -240,6 +255,35 @@ Thanks to **@martinus** for the fast hash maps implementation.
240255

241256
## Changelog
242257

258+
259+
### Version 1.3.1
260+
261+
#### Changes and improvements
262+
- bump deps versions
263+
- add new json binding - boost::json
264+
- speedup regex parsing by switching to boost::regex(std::regex extremely slow)
265+
- templates are now loading faster
266+
267+
#### Fixed bugs
268+
- small fixes across code base
269+
270+
#### Breaking changes
271+
- internal deps now used through cmake fetch_content
272+
- default json serializer/deserializer is switched to boost::json
273+
274+
### Version 1.2.1
275+
276+
#### Changes and improvements
277+
- bump deps versions
278+
- support modern compilers(up to Clang 12) and standards(C++20)
279+
- tiny code style cleanup
280+
281+
#### Fixed bugs
282+
- small fixes across code base
283+
284+
#### Breaking changes
285+
- internal deps point to make based boost build
286+
243287
### Version 1.1.0
244288
#### Changes and improvements
245289
- `batch` filter added
@@ -297,13 +341,13 @@ Thanks to **@martinus** for the fast hash maps implementation.
297341

298342
### Version 0.9.2
299343
#### Major changes
300-
- User-defined callables implemented. Now you can define your own callable objects, pass them as input parameters and use them inside templates as regular (global) functions, filters or testers. See details here: https://jinja2cpp.dev/docs/usage/ud_callables.html
344+
- User-defined callables implemented. Now you can define your own callable objects, pass them as input parameters and use them inside templates as regular (global) functions, filters or testers. See details here: https://jinja2cpp.github.io/docs/usage/ud_callables.html
301345
- Now you can define global (template environment-wide) parameters that are accessible for all templates bound to this environment.
302346
- `include`, `import` and `from` statements implemented. Now it's possible to include other templates and use macros from other templates.
303347
- `with` statement implemented
304348
- `do` statement implemented
305349
- Sample build projects for various Jinja2C++ usage variants created: https://github.com/jinja2cpp/examples-build](https://github.com/jinja2cpp/examples-build)
306-
- Documentation site created for Jinja2C++: https://jinja2cpp.dev/
350+
- Documentation site created for Jinja2C++: https://jinja2cpp.github.io
307351

308352
#### Minor changes
309353
- Render-time error handling added

0 commit comments

Comments
 (0)