From 7971cb0aa3e517a53f0ce6d3ee9bc3179041ccb8 Mon Sep 17 00:00:00 2001
From: John Klug <john.klug@multitech.com>
Date: Wed, 25 May 2022 17:12:18 -0500
Subject: mLinux 6

---
 README | 121 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 121 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..21b13b1
--- /dev/null
+++ b/README
@@ -0,0 +1,121 @@
+This is the branch for mLinux >= 6.0.0
+
+mLinux - MultiTech Linux for MultiConnect Conduit gateways
+============================================================
+
+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
+
+This branch is based on Yocto Thud.  Atmel devices use kernel Linux-AT91 4.9.
+
+It is no longer safe to assume MTCDT for the MACHINE type.  All builds
+now require the external variable MACHINE to be set.
+
+Building MTCDTIP2 requires:
+
+MACHINE=mtcap
+
+
+-------------------------
+       BUILDING
+-------------------------
+
+All version between 5.1 and 5.3.0a inclusive have
+cellular issues with modems becoming disabled
+due to COPS=2 set more or less permanently
+on rare occassions.
+
+Version 5.3.0a through 5.3.0c have issues with git
+trying to access unreachable repositories.  The
+recommended version after 5.0.x is 5.3.0d.
+
+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.
+
+1. Build from tarball
+
+    tar xzf mLinux-3.0.0.tar.gz
+    cd mlinux-3.0.0
+    # install needed dependencies, see scripts in install-deps
+    # Also switch to the build directory.
+    # example: sudo ./install-deps/install-debian-ubuntu-deps.sh
+    source oe-init-build-env
+
+    # set your default machine type in conf/local.conf
+    # MACHINE="mtcdt"
+
+    # build an image
+    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 install-deps
+    # example: sudo ./install-deps/install-debian-ubuntu-deps.sh
+
+    # initialize git submodules and setup dir structure
+    ./setup.sh
+    # setup.sh generates a random mtadm password, and places the
+    # password in build/conf/local.conf and password.txt
+    #
+    #
+    # The specified password is ignored for commissioning images.
+    # 
+    # To specify a password use an environmental variable,
+    # MTADM_PASSWORD
+    MTADM_PASSWORD="3g_t1zX0" ./setup.sh 
+    #
+    # To change the password, remove MTADM_PASSWORD and
+    # MTADM_PASSWORD_HASH from conf/local.conf and re-run:
+    MTADM_PASSWORD="Y5bG3m_2" ./setup.sh
+
+    # setup environment and switch to build directory
+    source oe-init-build-env
+
+    # set your default machine type in conf/local.conf
+    # MACHINE="mtcdt"
+
+    # build an image (current working directory is
+    # build)
+    bitbake mlinux-base-image
+
+-------------------------
+        IMAGES
+-------------------------
+
+mlinux-base-image: Small image with essential packages -- good starting point for a custom image
+
+mlinux-commissioning-image: Large image loaded on units by default -- contains full language support (perl, python)
+mlinux-mtcap-commissioning-image: MTCAP image
+
+-------------------------
+    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.
+
+You can also join the available developer forums to post queries and receive 
+updates from MultiTech developers.
+
-- 
cgit v1.2.3