Update page 'Welcome'
authorRISCI_ATOM <bob@bobcall.me>
Sat, 17 Dec 2016 18:34:37 +0000 (13:34 -0500)
committerRISCI_ATOM <bob@bobcall.me>
Sat, 17 Dec 2016 18:34:37 +0000 (13:34 -0500)
Welcome.md [new file with mode: 0644]

diff --git a/Welcome.md b/Welcome.md
new file mode 100644 (file)
index 0000000..461209d
--- /dev/null
@@ -0,0 +1,70 @@
+# libreCMC : The libre Embedded GNU/Linux Distro\r
+\r
+The libreCMC project is a set of fully [free](https://www.gnu.org/philosophy/free-sw.en.html) [embedded](/wiki/embedded) Operating Systems\r
+that give users the freedom to control their computing. Our primary project is an embedded GNU/Linux-libre \r
+distro that is based upon the upstream OpenWRT/LEDE project. The main difference between OpenWRT/LEDE and libreCMC\r
+are the fact that the project removes all [non-free](https://www.gnu.org/philosophy/categories.en.html#non-freeSoftware) packages, drivers and firmware blobs where the sources are not available under a free software license.\r
+\r
+## Why would I use libreCMC?\r
+\r
+Full control over your computing! In many cases, a variety of embedded devices require components where the sources\r
+are not available to the community under a Free Software license. These non-free parts mean that the community can't\r
+fix bugs, security flaws or even use a newer kernel because drivers don't work with newer versions of the kernel. By using these non-free parts,the user is at the mercy of the OEM or manufacture to maintain support for newer drivers that work with newer versions of the Linux™ kernel.\r
+\r
+# Quick Start Build Guide\r
+\r
+1) Checkout libreCMC\r
+\r
+`git clone https://gogs.librecmc.org/libreCMC/libreCMC.git`\r
+\r
+2) Enter the libreCMC directory (from now on referred by `$SRC_ROOT`)\r
+\r
+`cd $SRC_ROOT`\r
+\r
+3) Configure the build for the [supported device](/wiki/Supported-Hardware) and\r
+the packages that you may want to have. Some targets may have a very limited amount\r
+of flash (primary storage) and may not have the room for certain configurations of \r
+packages.\r
+\r
+Also, in order to build libreCMC, make sure that you have all needed [dependencies](/wiki/How-To-Build-libreCMC#what-do-i-need-to-get-started).\r
+After having installed all the necessary dependencies run:\r
+\r
+`make menuconfig`\r
+\r
+This will bring up the ncurses menuconfig interface for configuring libreCMC.\r
+\r
+A good default configuration for many people would be to include:\r
+\r
+* Luci -> luci, luci-ssl\r
+* Base System -> ca-bundle, sqm-scripts[-extra]\r
+\r
+4) Actually start the build:\r
+\r
+'make` : To speed things up, you can add a few more threads to the build by using `make -j4`\r
+\r
+5) Wait....\r
+\r
+Depending on the machine you have access to and the configuration you selected, it will take sometime to build libreCMC. \r
+\r
+       a) What if something goes wrong with the build? Run:\r
+       `make V=s` : This will allow for the build to be debugged. Sometimes a source package mirror is down or a dependency is missing. This\r
+       will allow us to figure out what is going wrong.\r
+\r
+\r
+       b) The build finished, but there is no image for my device! If you select more packages than can fit in flash, then some packages will\r
+       need to be removed from the configuration. After removing some packages, start the build again. Be careful when removing packages from\r
+       the configuration. Some packages are very important for basic functionality or are needed for other packages in the base system.\r
+\r
+       If you have a device that has <8M of flash, then try removing `Base System -> opkg*, ca-bundle`.\r
+\r
+\r
+6) If everything went OK, there should be a new image in `$SRC_ROOT/bin/targets/$TARGET/generic/`\r
+\r
+\r
+# Where do I go from here?\r
+\r
+Well, it depends on many factors. libreCMC can be used for many different use cases. If you need help with libreCMC, help can be found on IRC using:\r
+\r
+server :`FreeNode`\r
+\r
+channel : `#libreCMC`
\ No newline at end of file