Commit badade1e authored by Ben Walker's avatar Ben Walker Committed by Daniel Verkamp
Browse files

Update the README to point users at the examples. 



This is very minimal and needs to be expanded, but
at least point the users at the examples as the next
place to go.

Change-Id: I74025f7addb994f97d01accb89d2e9bc870740bf
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent add1515c

README.md

+11 −0
Original line number Diff line number Diff line
@@ -88,6 +88,17 @@ Hugepages and Device Binding 
Before running an SPDK application, some hugepages must be allocated and

any NVMe and I/OAT devices must be unbound from the native kernel drivers.

SPDK includes scripts to automate this process on both Linux and FreeBSD.

Both of these scripts should be run as root.



    1) scripts/configure_hugepages.sh

    2) scripts/setup.sh



Examples

========



Example code is located in the examples directory. The examples are compiled

automatically as part of the build process. Simply call any of the examples

with no arguments to see the help output. You'll likely need to run the examples

as a privileged user (root) unless you've done additional configuration

to grant your user permission to allocate huge pages and map devices through

vfio.