Skip to content
Snippets Groups Projects
Commit 601adea5 authored by Joan Vallvé Navarro's avatar Joan Vallvé Navarro
Browse files

Update README.md

parent 9608aef3
No related branches found
No related tags found
1 merge request!2Devel
...@@ -64,22 +64,26 @@ Let `${falkolib_ROOT}` be the install directory of your local copy ...@@ -64,22 +64,26 @@ Let `${falkolib_ROOT}` be the install directory of your local copy
of library falkolib. of library falkolib.
The following standard commands are required to compile it: The following standard commands are required to compile it:
- `cd ${falkolib_ROOT}` ```sh
- `mkdir build` cd ${falkolib_ROOT}
- `cd build` mkdir build
- `cmake ..` cd build
- `make` cmake ..
make
```
You can also install the library into a system directory. You can also install the library into a system directory.
To change the install directory you must set cmake environment To change the install directory you must set cmake environment
variable `${CMAKE_INSTALL_PREFIX}` (e.g. using command "ccmake .." variable `${CMAKE_INSTALL_PREFIX}` (e.g. using command `ccmake ..`
before calling "cmake .."). before calling `cmake ..`).
Its default value on UNIX-like/Linux systems is "/usr/local". Its default value on UNIX-like/Linux systems is "/usr/local".
After compiling library falkolib, run the command: After compiling library falkolib, run the command:
- `sudo make install` ```sh
sudo make install
```
The command "sudo" is required only if `${CMAKE_INSTALL_PREFIX}` The command `sudo` is required only if `${CMAKE_INSTALL_PREFIX}`
is a system diretory managed by administrator user root. is a system diretory managed by administrator user root.
Such command copies: Such command copies:
- header files of `${falkolib_ROOT}/include/falkolib` to - header files of `${falkolib_ROOT}/include/falkolib` to
...@@ -87,7 +91,7 @@ Such command copies: ...@@ -87,7 +91,7 @@ Such command copies:
- library files `${falkolib_ROOT}/lib/libfalkolib.a` to - library files `${falkolib_ROOT}/lib/libfalkolib.a` to
`${CMAKE_INSTALL_PREFIX}/lib/` `${CMAKE_INSTALL_PREFIX}/lib/`
- cmake script `${falkolib_ROOT}/cmake_modules/falkolibConfig.cmake` to - cmake script `${falkolib_ROOT}/cmake_modules/falkolibConfig.cmake` to
${CMAKE_INSTALL_PREFIX}/share/falkolib/ `${CMAKE_INSTALL_PREFIX}/share/falkolib/`
HOW TO USE LIBRARY falkolib IN YOUR PROJECT HOW TO USE LIBRARY falkolib IN YOUR PROJECT
...@@ -117,7 +121,7 @@ add_executable(foobar foobar.cpp) ...@@ -117,7 +121,7 @@ add_executable(foobar foobar.cpp)
target_link_libraries(foobar ${falkolib_LIBRARIES}) target_link_libraries(foobar ${falkolib_LIBRARIES})
``` ```
The above example uses the variables defined in falkolibConfig.cmake: The above example uses the variables defined in `falkolibConfig.cmake`:
- `falkolib_FOUND` - system has falkolib module - `falkolib_FOUND` - system has falkolib module
- `falkolib_INCLUDE_DIRS` - the falkolib include directories - `falkolib_INCLUDE_DIRS` - the falkolib include directories
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment