xref: /dpdk/doc/guides/freebsd_gsg/intro.rst (revision 5cfaa3c3b00300ef840270ecfe6820fdb99520e6)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2010-2014 Intel Corporation.
3
4Introduction
5============
6
7This document contains instructions for installing and configuring the
8Data Plane Development Kit (DPDK) software. It is designed to get customers
9up and running quickly and describes how to compile and run a
10DPDK application in a FreeBSD application (freebsd) environment, without going
11deeply into detail.
12
13For a comprehensive guide to installing and using FreeBSD, the following
14handbook is available from the FreeBSD Documentation Project:
15`FreeBSD Handbook <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_.
16
17.. note::
18
19   DPDK is now available as part of the FreeBSD ports collection and as a pre-built package.
20   Installing via the ports collection or FreeBSD `pkg` infrastructure is now the recommended
21   way to install DPDK on FreeBSD, and is documented in the next chapter, :ref:`install_from_ports`.
22
23Documentation Roadmap
24---------------------
25
26.. include:: ../linux_gsg/doc_roadmap.include.rst
27