summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJesse Gilles <jgilles@multitech.com>2014-11-04 12:47:52 -0600
committerJesse Gilles <jgilles@multitech.com>2014-11-04 12:47:52 -0600
commitb53cc1b1fcbb0548ef349f2060b7dc831377b2eb (patch)
tree20b9617d7f5b058230e0c2de54303caf4722deae
parent1f498c25dc1754c5a689e13022e3c5110c6fd170 (diff)
downloadmlinux-b53cc1b1fcbb0548ef349f2060b7dc831377b2eb.tar.gz
mlinux-b53cc1b1fcbb0548ef349f2060b7dc831377b2eb.tar.bz2
mlinux-b53cc1b1fcbb0548ef349f2060b7dc831377b2eb.zip
add LICENSE, README
-rw-r--r--LICENSE27
-rw-r--r--README75
2 files changed, 102 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..7ed0be5
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,27 @@
+MultiTech mLinux is a software build system and custom Linux distribution.
+It is your responsibility to review each license of the contained products
+to understand what is, and what is not, allowed by each such license.
+
+The OpenEmbedded-Core common-licenses directory 'layers/openembedded-core/meta/files/common-licenses/'
+contains licenses represented within this distribution. To the extent a license
+is not contained in the 'common-licenses' directory, it is referenced in the
+software and remains your responsibility to review.
+
+Different components of OpenEmbedded-Core are under different licenses (a mix
+of MIT and GPLv2). Please see:
+
+layers/openembedded-core/meta/COPYING.GPLv2 (GPLv2)
+layers/openembedded-core/meta/COPYING.MIT (MIT)
+
+For licensing information for other layers, see the files included with
+that particular layer in the layers subdirectory.
+
+All MultiTech-copyrighted software contained in mLinux is covered by
+GPL (GNU General Public License) version 2, unless provided under a different license.
+
+All bitbake metadata is MIT licensed unless otherwise stated. Source code
+included in tree for individual recipes is under the LICENSE stated in
+the associated recipe (.bb file) unless otherwise stated.
+
+License information for any other files is either explicitly stated
+or defaults to GPL version 2.
diff --git a/README b/README
new file mode 100644
index 0000000..d34cdff
--- /dev/null
+++ b/README
@@ -0,0 +1,75 @@
+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).
+
+mLinux utilizes OpenEmbedded-Core, Bitbake, which are part of the Yocto Project.
+
+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
+
+ 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.
+
+ 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.
+
+ tar xzf mLinux-3.0.0.tar.gz
+ cd mlinux-3.0.0
+ # install needed dependencies, see scripts in multitech/contrib/install-deps
+ # example: sudo ./install-deps/install-debian-ubuntu-deps.sh
+ source env-oe.sh
+
+ # set your default machine type in conf/local.conf
+ # MACHINE="mtcdt"
+
+ bitbake mlinux-base-image
+
+2. Build from git repository
+
+ # clone repo to a dir name of your choice
+ git clone git://git.multitech.net/mlinux.git mlinux-3.0.0
+ cd mlinux-3.0.0
+
+ # checkout desired branch or tag
+ git checkout 3.0.0
+
+ # install needed dependencies, see scripts in multitech/contrib/install-deps
+ # example: sudo ./multitech/contrib/install-deps/install-debian-ubuntu-deps.sh
+
+ # initialize git submodules and setup dir structure
+ ./setup.sh
+
+ # setup environment
+ source env-oe.sh
+
+ # set your default machine type in conf/local.conf
+ # MACHINE="mtcdt"
+
+ # build!
+ bitbake mlinux-base-image
+
+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.
+
+You can also join the available developer forums to post queries and receive
+updates from MultiTech developers.
+