summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJesse Gilles <jgilles@multitech.com>2011-09-29 15:40:07 -0500
committerJesse Gilles <jgilles@multitech.com>2011-09-29 15:40:07 -0500
commit8e36a211333cb277fce96ec00977e35e9d7bc39a (patch)
tree24dec8ff4420c366d6793e84d6bf0d275e361268 /README
parent21328fbd89ee192e42f95dc92aec3fc1d1185868 (diff)
update README
Diffstat (limited to 'README')
-rw-r--r--README60
1 files changed, 60 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..708b432
--- /dev/null
+++ b/README
@@ -0,0 +1,60 @@
+CoreCDP - Multi-Tech Linux for MultiConnect Open Communication Gateways
+=======================================================================
+
+What is it?
+-----------
+
+CoreCDP is a distribution provided by Multi-Tech tailored for the MultiConnect
+Open Communication Gateway (OCG) products (MTCDP, MT100EOCG models).
+
+CoreCDP utilizes the OpenEmbedded framework and is based on the Angstrom
+distribution. OpenEmbedded provides a complete environment for cross-compiling
+1000's of open source software packages.
+
+For more information about CoreCDP, see http://www.multitech.net
+
+For more information about OpenEmbedded, see http://www.openembedded.org
+
+How to get started?
+-------------------
+
+1. Build from tarball
+
+Download the file 'corecdp-2.0.0.tar.gz' (release number may vary) from the
+http://www.multitech.net website or copy it from the provided DVD. This file
+provides the CoreCDP build system and a set of sources sufficient for building
+the sample images provided by CoreCDP.
+
+Untar the contents to a folder of your choice, and install prerequisite
+packages. Then, configure the environment variables and you are good to go.
+
+tar xzf corecdp-2.0.0.tar.gz
+cd corecdp-2.0.0
+source env-oe.sh
+bitbake corecdp-base-image
+
+2. Build from git repository
+
+# clone repo to a dir name of your choice
+git clone git://git.multitech.net/corecdp.git corecdp-2.0.0
+
+# checkout desired branch or tag
+git checkout 2.0.0
+cd corecdp-2.0.0
+
+# initialize git submodules and setup dir structure
+./setup.sh
+
+# setup environment
+source env-oe.sh
+
+# build!
+bitbake corecdp-base-image
+
+See the Multi-Tech Developer website (http://www.multitech.net) for full
+installation and build instructions. In particular, see the "Introduction" and
+"Getting Started" pages under the MultiConnect OCG section.
+
+You can also join the available developer forums to post queries and receive
+updates from Multi-Tech developers.
+