1 files changed, 260 insertions, 0 deletions

diff --git a/documentation/README.release b/documentation/README.release
new file mode 100644
index 0000000..ed8f2d3
--- /dev/null
+++ b/documentation/README.release
@@ -0,0 +1,260 @@
+
+                     Enea Linux 5 for PPC
+                     ====================
+
+Release version: 5.0-ppc
+
+This README provides a quick introduction on how to boot Enea Linux
+and install packages using the smart package manager.
+
+In this README you will find the following information:
+* WHAT IS ENEA LINUX
+* DOCUMENTTION
+* QUICK GETTING STARTED
+* DELIVERABLES IN THIS RELEASE
+* HOW TO USE SMART PACKAGE MANAGER
+* SUPPORT INFORMATION
+
+
+WHAT IS ENEA LINUX
+==================
+
+Enea Linux is an open source distribution providing hardened and well supported
+Linux for customized hardware. The source code is continuously downstreamed
+from Yocto Project (www.yoctoproject.org - Yocto Project, A Linux Foundation
+Collaborative Project. All Rights Reserved.) and tested by Enea.
+
+With Enea Linux you get a Yocto Project compatible development environment
+allowing you to build embedded Linux kernels and toolchains on a Linux host,
+to customize embedded Linux kernels for a specific hardware architecture,
+and to build and troubleshoot embedded Linux applications on target.
+
+Enea Linux provides you with verified and easily installed board support
+packages (BSP) for your hardware architectures. Each BSP includes a Linux kernel
+and a root filesystem (rootfs), plus a number of packages that can be extended
+on request. You also get the packages required for building images on any of
+the supported Linux distributions for your host.
+
+This version of Enea Linux is distributed via linux.enea.com and is publicly
+available for download.
+
+Read more about Enea Linux on www.enea.com.
+
+
+QUICK GETTING STARTED
+=====================
+The steps below summarize how to install, build, and boot Enea Linux.
+For B-D you find detailed instructions in Enea Linux User's Guide,
+chapters "Getting Started" and "Target Guide".
+
+A. Prepare the installation:
+   * Browse to https://linux.enea.com/5.0-ppc/documentation
+   * Read the Release Information
+   * Open the User's Guide
+
+B. Install Enea Linux on host:
+
+   1. Ensure that system requirements are met.
+
+   2. Install the packages needed for your host's Linux distribution.
+
+   3. Download tarballs and install them on the host.
+      The top directory of each tarball is Enea-Linux-5.0-ppc.
+
+         # Download Enea-Linux-5.0-ppc.tar.gz      # precompiled images
+         $ tar xzf Enea-Linux-5.0-ppc.tar.gz
+
+         # Download Enea-Linux-doc_5.0-ppc.tar.gz  # documentation
+         $ tar xzf Enea-Linux-doc_5.0-ppc.tar.gz
+
+         $ cd Enea-Linux-5.0-ppc
+         # Download Enea-Linux-Eclipse_4.0.tar.gz    # Eclipse with plug-ins
+         $ tar xzf Enea-Linux-Eclipse_4.0.tar.gz
+
+      The Eclipse tarball is the same as in Enea Linux 4.0.
+
+C. Get Enea Linux up and running on the target:
+
+   4. Get images (kernel, device tree, rootfs) for your target, either the
+      downloaded precompiled binaries, or by using bitbake to build your own
+      images from source. NOTE: Building your own images requires that you
+      first source the init script on the host to set up the build environment.
+
+      Generic instruction for how to build your own images:
+
+         $ source enea-init-build-env -m <machine> -l <layers> [other options]
+         $ bitbake enea-image-<name>
+
+   5. Boot Enea Linux on your target.
+
+D. If desired, develop applications:
+
+   6. Install the cross-compilation toolchain (SDK).
+
+   7. Cross-compile application/s for your target and run them in Enea Linux.
+
+   8. Use the Eclipse tools:
+      Start the eclipse program on host to open the Eclipse IDE, from where
+      you can customize images, build applications, trace and debug.
+      See chapter "Using Eclipse in Enea Linux".
+
+
+DELIVERABLES IN THIS RELEASE
+============================
+
+Documentation
+-------------
+The following Enea Linux manuals are available on the download server, both as
+a tarball for installation and in a documentation directory for direct reading:
+
+* README.release (this file)
+* Enea Linux Release Information (PDF, HTML)
+* Enea Linux User's Guide (PDF, HTML)
+* Enea Linux Open Source Report (PDF, HTML)
+* Enea Linux Eclipse Open Source Report (PDF, HTML)
+
+
+Variables in file names
+-----------------------
+To simplify this README, long file names have been condensed by using
+the following variables:
+
+  <release>    = 5.0-ppc
+  <sdkversion> = 5.0-ppc
+  <target>     = t4240rdb-64b
+  <name>       = base or featured
+  <image>      = enea-image-<name>
+  <sdkimage>   = enea-image-featured
+  <hostarch>   = x86_64
+  <targetarch> = ppc64e6500
+  <libc>       = glibc
+  <distro>     = enea
+  <toolchain>  = <distro>-<libc>-<hostarch>-<sdkimage>-<targetarch>-toolchain
+
+
+Contents on download site
+-------------------------
+The Enea Linux download site contains, among other things, precompiled images,
+source for bitbake builds, and the latest documentation for the release.
+
+The example below lists the typical contents on the download server.
+Some files are present for certain targets only. Other files and directories
+might be present, e.g. <file>.sha1 with a unique SHA-1 number for each <file>.
+
+!-- Enea-Linux-<release>.tar.gz          /* packed Enea Linux distribution */
+!-- Enea-Linux-doc_<release>.tar.gz     /* packed Enea Linux documentation */
+!-- Enea-Linux-Eclipse_<release>.tar.gz/*packed tools:eclipse,yocto-plugins*/
+!-- documentation/                             /* Enea Linux documentation */
+!-- patches/                                   /* critical patches by Enea */
+!-- sources/                                           /* code and patches */
+!-- <target>/           /* BSP-specific directories for supported hardware */
+!   `-- <image>
+!      `-- images/                                 /* precompiled binaries */
+!         `--<target>/
+!            `-- [u|z]Image-<target>.bin                   /* kernel image */
+!            `-- [u|z]Image[-<variant>].dtb            /* device-tree file */
+!            `-- README_*                  /* simplified build instruction */
+!            `-- <x>.ext2.gz                        /* rootfs for RAM-boot */
+!            `-- <x>.manifest                 /* list of packages in image */
+!            `-- <x>.tar.gz                         /* rootfs for NFS-boot */
+!            `-- modules[-<target>].tgz           /* packed kernel modules */
+!    `-- rpm/                                             /* .rpm packages */
+!    `-- licenses/                             /* license info per package */
+!    `-- sdk/
+!       `- <toolchain>-<sdkversion>.manifest    /* list of packages in SDK */
+!       `- <toolchain>-<sdkversion>.sh         /* self-extracting archive...
+                             ...installing the cross-compilation toolchain */
+
+
+Contents on host after installation
+-----------------------------------
+After the installation, you should have, among others, the following files
+on your host:
+
+!-- Enea-Linux-<release>/
+!   `-- documentation/                         /* Enea Linux documentation */
+!       `-- README.htm                              /* documentation index */
+!       `-- README.release                      /* overview of the release */
+!       `-- book-enea-linux-*                                   /* manuals */
+!   `-- poky/
+!       `-- LICENSE            /* License file for OpenEmbedded components */
+!       `-- README                  /* what is Poky, where to send patches */
+!       `-- README.hardware     /* how to use Poky with reference machines */
+!       `-- bitbake/                           /* bitbake script, lib, doc */
+!       `-- documentation/         /* yocto manuals source and build files */
+!       `-- enea-init-build-env           /* script that sets up build env */
+!       `-- oe-init-build-env   /* script that partially sets up build env */
+!                          /* ...from cmd line but also requires file edit */
+!       `-- meta[<-xxx>]/                 /* layers to add to bblayer.conf */
+!           `-- classes/                                 /* .bbclass files */
+!           `-- conf/      /* conf, inc files; machine (board) definitions */
+!           `-- recipes-<yyy>/             /* .bb, .bbappend, .patch files */
+!       `-- scripts/                       /* crosstap, hob, runqemu, a.o. */
+
+
+After unpacking the Eclipse tarball to Enea-Linux-<release>, you should also
+have the following files on your host:
+
+!-- Enea-Linux-<release>/
+!   `-- eclipse/         /* eclipse binary and plugins (CDT, RSE, SDK, ...) */
+!   `-- yocto-plugins/      /* additional plugins with tools from Yocto ADT */
+
+
+HOW TO USE SMART PACKAGE MANAGER
+================================
+
+Prerequisites
+-------------
+- The rpms are located at https://linux.enea.com/RPM/5.0-ppc/
+  Note: it's also possible to setup your own webserver and upload rpms there
+- Set namesever in the booted target, e.g.
+  root@t4240rdb-64b:~# vi /etc/resolv.conf
+  nameserver <ip_addr_of_dns>
+
+Using smart
+------------
+1. Setup smart channels and update
+The following commands will setup channels on target t4240rdb_64b:
+# smart channel -y --add all type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/all
+# smart channel -y --add t4240rdb_64b type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/t4240rdb_64b
+# smart channel -y --add ppc64e6500 type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/ppc64e6500
+# smart channel -y --add lib32_ppce6500 type=rpm-md baseurl=https://linux.enea.com/RPM/5.0-ppc/lib32_ppce6500
+
+Now update Package Manager metadata using this command:
+# smart update
+
+You are all set; ready to choose and pick what you need for your development.
+
+2. Install and remove packages
+Smart includes thousands of packages that can be searched. As an example,
+let's search for fmc:
+# smart search fmc
+  Loading cache...
+  Updating cache...             ######################################## [100%]
+
+  fmc - fmc version git-r2
+  fmc-dbg - fmc version git-r2 - Debugging files
+  fmc-dev - fmc version git-r2 - Development files
+  fmc-staticdev - fmc version git-r2 - Development files (Static Libraries)
+
+You can use the following command to install a package. As an example,
+let's install fmc:
+# smart install fmc
+
+You can use the following command to remove a package. As an example,
+let's remove fmc:
+# smart remove fmc
+
+For more information about smart, please visit their official website at
+http://labix.org/smart.
+
+
+SUPPORT INFORMATION
+===================
+
+Enea can provide more packages on demand and help our customers in customizing
+Enea Linux for new hardware. We also fix bugs and contribute patches to Yocto,
+and supervise status of reported bugs in the open source community.
+You find us at www.enea.com/support.
+
+Enjoy your Enea Linux!