From: RISCi_ATOM <bob@bobcall.me>
Date: Thu, 18 Oct 2018 01:18:50 +0000 (-0400)
Subject: Add image flavor description
X-Git-Tag: v1.4.6~22
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=f817611c905bd1ee24deb27be81cf6ccb5e0ab1e;p=librecmc%2Flibrecmc.git

Add image flavor description
---

diff --git a/docs/Flavors.md b/docs/Flavors.md
new file mode 100644
index 0000000000..bc22ce9521
--- /dev/null
+++ b/docs/Flavors.md
@@ -0,0 +1,24 @@
+# Three Flavors of libreCMC : What are they for?
+
+The libreCMC project ships different flavored images to achieve a desired result and 
+allows for the continued support of hardware with limited resources. These different flavors
+include:
+
+## Main
+
+Provides an easier to use out of the box experience; includes
+the luci web interface, full package management support and basic IPv6 stack. 
+These images only run on routers with more than 8M of flash.
+
+## Core
+
+A bare-bones image with package management, basic IPv6 stack and no web interface.
+These images on routers with <8M of flash, but package management is limited on 4M targets.
+
+## Legacy
+
+While similar to Main images, these images are targeted at routers with 4M of flash;
+provide the luci web-ui (no ssl support), basic IPv6 stack and no package management.
+
+As always, libreCMC can be built from [source](https://gogs.librecmc.org/libreCMC/libreCMC/src/v1.4/docs/How_To_Build_libreCMC.md) or you can submit an [issue](https://gogs.librecmc.org/libreCMC/libreCMC/issues) to request
+a missing feature.