aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lib.md
diff options
context:
space:
mode:
authorOlivier Roques <oroques+fdio@cisco.com>2020-02-25 18:00:42 +0100
committerOlivier Roques <oroques+fdio@cisco.com>2020-02-25 19:00:34 +0100
commita2c5df5ce653ba6362931cb7eda0fb53b002f8ac (patch)
treed71176391a1654c17bb6836e94f23c2944368b35 /docs/source/lib.md
parent0e7669445b6be1163189521eabed7dd0124043c8 (diff)
[HICN-533] Update and format documentation
This patch fixes misspells, improves readability and tries to make the different source files consistent between each other. It also updates hiperf usage and hicn + VPP installation (in utils.md) and fixes some mistakes related to collectd plugins (in telemetry.md). Change-Id: I100a1c7e40dbe9c485ae4548ffc653765f4421b9 Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
Diffstat (limited to 'docs/source/lib.md')
-rw-r--r--docs/source/lib.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/source/lib.md b/docs/source/lib.md
index 1e7d09e7a..bd021d30c 100644
--- a/docs/source/lib.md
+++ b/docs/source/lib.md
@@ -1,5 +1,4 @@
-
-# Core Library
+# Core library
## Introduction
@@ -30,9 +29,9 @@ A commandline interface (hicnc) is also provided that uses the library and can
for instance be used as a test traffic generator. This interface can be run as
either a consumer, a producer, or a simple forwarder.
-## Directory Layout
+## Directory layout
-```shell
+```bash
.
+-- CMakeLists.txt CMkake global build file
+-- doc Package documentation
@@ -45,7 +44,7 @@ either a consumer, a producer, or a simple forwarder.
| +-- error.{h,c} Error management files
| +-- header.h hICN header definitions
| +-- hicn.h Master include file
-| +-- mapme.{h,c} MAP-Me : anchorless producer mobility mechanisms
+| +-- mapme.{h,c} MAP-Me : anchorless producer mobility mechanisms
| +-- name.{h,c} hICN naming conventions and name processing + IP helpers
| +-- ops.{h,c} Protocol-independent hICN operations
| +-- protocol/* Protocol headers + protocol-dependent implementations
@@ -67,16 +66,20 @@ Basic dependencies: None
### Release mode
+```bash
mkdir build
cd build
cmake ..
make
sudo make install
+```
### Debug mode
+```bash
mkdir debug
cd debug
cmake .. -DCMAKE_BUILD_TYPE=Debug
make
sudo make install
+```