embed.md (1945B)
1 --- 2 title: Embedding 3 description: A guide on how to embed the cwalk path library for C/C++. 4 --- 5 6 7 In order to embed **cwalk**, you will have to download it. 8 You can do so using git (or download it from [here](https://github.com/likle/cwalk/archive/stable.zip)). 9 10 ```bash 11 git clone -b stable git@github.com:likle/cwalk.git 12 ``` 13 **Note**: The *stable* branch points to the latest stable version. You should 14 always use a stable version in production code. 15 16 ## Using CMake to embed cwalk 17 If you are using CMake it is fairly easy to embed **cwalk**. 18 This only requires two lines, you don't even have to specify the include directories. 19 The following example shows how to do so: 20 ```cmake 21 # Some basics you will need in your cmake file. 22 cmake_minimum_required(VERSION 3.9.2) 23 project(example C) 24 add_executable(example_target main.c) 25 26 # Replace your_path_to_cwalk with the path to your cwalk copy. 27 # This could be something like "${CMAKE_CURRENT_SOURCE_DIR}/lib/cwalk". 28 add_subdirectory(your_path_to_cwalk) 29 30 # Replace example_target with the target name which requires cwalk. 31 # After this, there is no need to specify any include directories. 32 target_link_libraries(example_target cwalk) 33 ``` 34 35 After that, you should be able to use cwalk in your source code: 36 ```c 37 #include <cwalk.h> 38 ``` 39 40 ## Directly embed cwalk in your source 41 If you don't use CMake and would like to embed **cwalk** directly, you could 42 just add the two files ``src/cwalk.c`` and ``ìnclude/cwalk.h`` to your project. 43 The folder containing ``cwalk.h`` has to be in your include directories 44 ([Visual Studio](https://docs.microsoft.com/en-us/cpp/ide/vcpp-directories-property-page?view=vs-2017), 45 [Eclipse](https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.cdt.doc.user%2Freference%2Fcdt_u_prop_general_pns_inc.htm), 46 [gcc](https://www.rapidtables.com/code/linux/gcc/gcc-i.html), 47 [clang](https://clang.llvm.org/docs/ClangCommandLineReference.html#include-path-management)).