diff options
| author |   Chris Luke <chrisy@flirble.org> | 2017-09-27 15:09:48 -0400 |
|---|---|---|
| committer |   Florin Coras <florin.coras@gmail.com> | 2017-09-28 01:04:56 +0000 |
| commit | 64ebb5ff1338140d94c7f9ee72138fe84d89de2e (patch) | |
| tree | 338f13adac0036599943061d2fabfd673479643e /extras/libmemif/docs/BuildInstructions.md | |
| parent | 4ff586d1c6fc5c40e1548cd6f221a8a7f3ad033b (diff) | |
General documentation updates
- We now have several developer-focused docs, so create an index page
for them.
- Rework several docs to fit into the index structure.
- Experiment with code highlighting; tweak the CSS slightly to make
it slightly nicer to look at.
Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6
Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'extras/libmemif/docs/BuildInstructions.md')
| -rw-r--r-- | extras/libmemif/docs/BuildInstructions.md | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/extras/libmemif/docs/BuildInstructions.md b/extras/libmemif/docs/BuildInstructions.md deleted file mode 100644 index 9bb59b94c11..00000000000 --- a/extras/libmemif/docs/BuildInstructions.md +++ /dev/null @@ -1,54 +0,0 @@ -## Build Instructions - -Install dependencies -``` -# sudo apt-get install -y git autoconf pkg_config libtool check -``` - -Clone repository to your local machine. -``` -# git clone https://github.com/JakubGrajciar/libmemif.git -``` - -From root directory execute: -For debug build: -``` -# ./bootstrap -# ./configure -# make -# make install -``` - -For release build: -``` -# ./bootstrap -# ./configure -# make release -# make install -``` -Verify installation: -``` -# ./.libs/icmpr-epoll -``` -> Make sure to run the binary file from ./.libs. File ./icmp\_responder in libmemif root directory is script that links the library, so it only verifies successful build. Default install path is /usr/lib. -Use _help_ command to display build information and commands: -``` -ICMP_Responder:add_epoll_fd:204: fd 0 added to epoll -MEMIF_DEBUG:src/main.c:memif_init:383: app name: ICMP_Responder -ICMP_Responder:add_epoll_fd:204: fd 4 added to epoll -LIBMEMIF EXAMPLE APP: ICMP_Responder (debug) -============================== -libmemif version: 1.0 (debug) -memif version: 256 -commands: - help - prints this help - exit - exit app - conn <index> - create memif (slave-mode) - del <index> - delete memif - show - show connection details - ip-set <index> <ip-addr> - set interface ip address - rx-mode <index> <qid> <polling|interrupt> - set queue rx mode -``` -#### Examples - -Once the library is build/installed, refer to [Examples](../examples/README.md) and [Getting started](GettingStarted.md) for additional information on basic use cases and API usage. |