From 601adea5f9a4a126659c00d6d1d3841344980b4c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joan=20Vallv=C3=A9=20Navarro?= <jvallve@iri.upc.edu>
Date: Tue, 19 Oct 2021 16:07:02 +0200
Subject: [PATCH] Update README.md
---
README.md | 26 +++++++++++++++-----------
1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 4686894..b217408 100644
--- a/README.md
+++ b/README.md
@@ -64,22 +64,26 @@ Let `${falkolib_ROOT}` be the install directory of your local copy
of library falkolib.
The following standard commands are required to compile it:
-- `cd ${falkolib_ROOT}`
-- `mkdir build`
-- `cd build`
-- `cmake ..`
-- `make`
+```sh
+cd ${falkolib_ROOT}
+mkdir build
+cd build
+cmake ..
+make
+```
You can also install the library into a system directory.
To change the install directory you must set cmake environment
-variable `${CMAKE_INSTALL_PREFIX}` (e.g. using command "ccmake .."
-before calling "cmake ..").
+variable `${CMAKE_INSTALL_PREFIX}` (e.g. using command `ccmake ..`
+before calling `cmake ..`).
Its default value on UNIX-like/Linux systems is "/usr/local".
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.
Such command copies:
- header files of `${falkolib_ROOT}/include/falkolib` to
@@ -87,7 +91,7 @@ Such command copies:
- library files `${falkolib_ROOT}/lib/libfalkolib.a` to
`${CMAKE_INSTALL_PREFIX}/lib/`
- 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
@@ -117,7 +121,7 @@ add_executable(foobar foobar.cpp)
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_INCLUDE_DIRS` - the falkolib include directories
--
GitLab