summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCatalin Scrieciu <catalin.scrieciu@enea.com>2017-10-16 11:05:16 +0200
committerCatalin Scrieciu <catalin.scrieciu@enea.com>2017-10-16 11:05:16 +0200
commit1729af084e91917e6825d3a9dfaeb6f12a471262 (patch)
tree90ea68e650daaaaaa6a2a636b57e3f6a10b0fd24
parent91ab3bfda64c05327c55b07f10fbbc8dac433089 (diff)
downloadnfv-access-documentation-1729af084e91917e6825d3a9dfaeb6f12a471262.tar.gz
Adding content to the README file
-rw-r--r--doc/.README49
1 files changed, 48 insertions, 1 deletions
diff --git a/doc/.README b/doc/.README
index 87d7ece..2553a88 100644
--- a/doc/.README
+++ b/doc/.README
@@ -1 +1,48 @@
1Content of the file to be determined 11. Enea NFV Access Release Content
2
3The current release contains along with other items, documentation, pre-built kernels and images, a bootloader and a SDK. The directories structure is detailed below:
4
5-- Documentation/
6 /* NFV Access documentation */
7-- x86-64 /* architecture */
8 -- inteld1521/
9 /* artifacts for the host side */
10 -- deb/
11 /* deb packages */
12 -- images/
13 -- enea-nfv-access
14 /* precompiled artifacts for the platform release image */
15 -- various artifacts (rootfs, kernel, config etc.)
16 -- enea-nfv-access-dev
17 /* precompiled artifacts for development process. The image contains userspace tools and kernel configurations necessary for developing, debugging and profiling applications and kernel modules */
18 -- various artifacts
19 -- qemux86-64
20 /* artifacts for the guest side */
21 -- deb/
22 /* deb packages */
23 -- images/
24 -- enea-nfv-access-guest
25 /* precompiled artifacts for QEMU/Docker release image */
26 -- various artifacts
27 -- enea-nfv-access-guest-dev
28 /* precompiled artifacts for development process. The image contains userspace tools and kernel configurations necessary for developing, debugging and profiling applications and kernel modules */
29 -- various artifacts
30 -- install
31 -- sdk
32 /* SDK related artifacts including SDK installer and manifets */
33 -- install-sdk.sh
34 /* self-extracting archive installing cross-compilation toolchain for the platform */
35 -- nfv-installer
36 /* Various tools assisting in booting Enea NFV Access */
37 -- script-installer
38 /* installer tool intended for creating a bootable Enea NFV Access installation o a physical media */
39
402. Enea NFV Access Documentation
41
42Enea NFV Access is provided with the following set of documents:
43 - Enea NFV Access Release Information - This document, describing the Enea NFV Access release content.
44 - Enea NFV Access Guide - A document describing how to use Enea NFV Access, as well as use cases and benchmark results.
45 - Enea NFV Access Open Source Reports - Various documents describing the licenses and open source included with Enea NFV Access.
46 - Enea NFV Access Security Report - The document that lists all security fixes included in the Enea NFV Access release.
47
48All the documents are available in the "Documentation" directory, in the root of the release package.