Skip to content

Commit

Permalink
Beautified INSTALL document
Browse files Browse the repository at this point in the history
  • Loading branch information
gkatsikas committed Nov 10, 2017
1 parent fcb1eee commit 9230f46
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,65 +10,65 @@ CONFIGURE

Change to the SNF source directory and run:

`./bootstrap`
./bootstrap

This will initialize the required autotools to support the build process.
To build SNF with basic Click support run:

`./configure --with-click=<path-to-your-click-folder>`
./configure --with-click=<path-to-your-click-folder>

Example:

`./configure --with-click=~/nfv/click/`
./configure --with-click=~/nfv/click/

To build SNF with Click-DPDK support run:
`./configure \
./configure \
RTE_SDK=<path-to-your-dpdk-folder> \
RTE_TARGET=<your-dpdk-target> \
--with-click=<path-to-your-click-folder> \
--enable-dpdk=yes`
--enable-dpdk=yes

Example for Standard Click (with more verbosity but no debug messages):

`./configure \
./configure \
--with-click=~/nfv/click \
--enable-dpdk=no --enable-debug=no --enable-verbose=yes`
--enable-dpdk=no --enable-debug=no --enable-verbose=yes

Example for Click-DPDK (with more verbosity but no debug messages):

`./configure \
./configure \
RTE_SDK=~/nfv/dpdk \
RTE_TARGET=x86_64-native-linuxapp-gcc \
--with-click=~/nfv/click \
--enable-dpdk=yes --enable-debug=no --enable-verbose=yes`
--enable-dpdk=yes --enable-debug=no --enable-verbose=yes

INSTALL
---------
After `configure` stay at the SNF source directory and run:

`./install <your preferred destination for the SNF binaries, libraries, headers>`
./install <your preferred destination for the SNF binaries, libraries, headers>

If no argument is given, the local bin directory will be used.

RUN
---------
One can execute the following synthesis examples:

`./run bin/usr/local/bin/snf input/tests/tests.prop`
./run bin/usr/local/bin/snf input/tests/tests.prop

UN-INSTALL
---------
To un-install SNF change to the SNF source directory and run:

`./uninstall <your existing folder that contains the SNF binaries, libraries, headers>`
./uninstall <your existing folder that contains the SNF binaries, libraries, headers>

If no argument is given, the local bin directory will be used.

CLEAN
---------
To clean the repository change to the SNF source directory and run:

`./clean`
./clean

REPORT
---------
Expand Down

0 comments on commit 9230f46

Please sign in to comment.