Clarifications to README.md

* List the components in the development kit
* Mention the examples directory
* Add installation commands for dependencies

Change-Id: I31302b3cd2e5df4f24b8da30af66f9f1daa11eaa
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Ben Walker 2016-03-02 10:03:57 -07:00 committed by Gerrit Code Review
parent e3cabfafd7
commit add1515c86

View File

@ -10,18 +10,23 @@ Storage Performance Development Kit
The Storage Performance Development Kit (SPDK) provides a set of tools The Storage Performance Development Kit (SPDK) provides a set of tools
and libraries for writing high performance, scalable, user-mode storage and libraries for writing high performance, scalable, user-mode storage
applications. applications. It achieves high performance by moving all of the necessary
It achieves high performance by moving all of the necessary drivers into drivers into userspace and operating in a polled mode instead of relying on
userspace and operating in a polled mode instead of relying on interrupts, interrupts, which avoids kernel context switches and eliminates interrupt
which avoids kernel context switches and eliminates interrupt handling handling overhead.
overhead.
The development kit currently includes:
* NVMe driver
* I/OAT (DMA engine) driver
Documentation Documentation
============= =============
[Doxygen API documentation](https://spdk.github.io/spdk/doc/) [Doxygen API documentation](https://spdk.github.io/spdk/doc/) is available, as
well as a [Porting Guide](PORTING.md) for porting SPDK to different frameworks
and operating systems.
[Porting Guide](PORTING.md) Many examples are available in the `examples` directory.
[Changelog](CHANGELOG.md) [Changelog](CHANGELOG.md)
@ -32,18 +37,11 @@ To build SPDK, some dependencies must be installed.
Fedora/CentOS: Fedora/CentOS:
- gcc sudo dnf install -y gcc libpciaccess-devel CUnit-devel libaio-devel
- libpciaccess-devel
- CUnit-devel
- libaio-devel
Ubuntu/Debian: Ubuntu/Debian:
- gcc sudo apt-get install -y gcc libpciaccess-dev make libcunit1-dev libaio-dev
- libpciaccess-dev
- make
- libcunit1-dev
- libaio-dev
FreeBSD: FreeBSD: