summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesse Gilles <jgilles@multitech.com>2015-01-23 17:09:56 -0600
committerJesse Gilles <jgilles@multitech.com>2015-01-23 17:09:56 -0600
commitc3a8590e7d8ec8cdb3125d45813338ecd110fbe7 (patch)
treed8b0c4ec4601545b11f6a73691c1a861178c5f26
parent3f5ff56f1378e7c0596b85a7af6a197a7de49f44 (diff)
downloadmlinux-c3a8590e7d8ec8cdb3125d45813338ecd110fbe7.tar.gz
mlinux-c3a8590e7d8ec8cdb3125d45813338ecd110fbe7.tar.bz2
mlinux-c3a8590e7d8ec8cdb3125d45813338ecd110fbe7.zip
update README
-rw-r--r--README45
1 files changed, 27 insertions, 18 deletions
diff --git a/README b/README
index 72f026b..6051400 100644
--- a/README
+++ b/README
@@ -1,9 +1,6 @@
mLinux - MultiTech Linux for MultiConnect Conduit gateways
============================================================
-What is it?
------------
-
mLinux is a distribution provided by MultiTech tailored for the
MultiConnect Conduit products (MTCDT models).
@@ -14,22 +11,15 @@ For more information about mLinux, see http://www.multitech.net
For more information about the Yocto Project, see http://www.yoctoproject.org
For more information about OpenEmbedded, see http://www.openembedded.org
-How to get started?
--------------------
-
-1. Build from tarball
+-------------------------
+ BUILDING
+-------------------------
- Download the file 'mLinux-x.tar.gz' (where 'x' is the version) from
- http://www.multitech.net or copy it from the storage medium bundled with
- your developer kit. This file provides the mLinux build system and a set
- of sources sufficient for building the sample images provided by mLinux.
+Note that mLinux should *not* be built as root and you will need full write
+permissions to the build directory structure. It is recommended to build
+the software inside your $HOME dir as a normal user.
- Untar the contents to a folder of your choice, and install prerequisite packages.
- Then, configure the environment variables and you are good to go.
-
- Note that mLinux should *not* be built as root and you will need full write
- permissions to the build directory structure. It is recommended to extract and
- build the software inside your $HOME dir as a normal user.
+1. Build from tarball
tar xzf mLinux-3.0.0.tar.gz
cd mlinux-3.0.0
@@ -40,6 +30,7 @@ How to get started?
# set your default machine type in conf/local.conf
# MACHINE="mtcdt"
+ # build an image
bitbake mlinux-base-image
2. Build from git repository
@@ -63,9 +54,27 @@ How to get started?
# set your default machine type in conf/local.conf
# MACHINE="mtcdt"
- # build!
+ # build an image
bitbake mlinux-base-image
+-------------------------
+ IMAGES
+-------------------------
+
+mlinux-base-image: Small image with essential packages -- good starting point for a custom image
+
+mlinux-factory-image: Large image loaded on units by default -- contains full language support (perl, python, java, ruby, nodejs)
+
+-------------------------
+ PRE-BUILT IMAGES
+-------------------------
+
+http://multitech.net/mlinux/images
+
+-------------------------
+ MORE INFO
+-------------------------
+
See the MultiTech Developer website (http://www.multitech.net) for full
installation and build instructions. In particular, see the "Introduction" and
"Getting Started" pages under the mLinux section.