[initial-setup][rhel7-branch/master][PATCH] Populate README (#1110178)
mkolman at redhat.com
Thu Sep 25 19:19:21 UTC 2014
Signed-off-by: Martin Kolman <mkolman at redhat.com>
MANIFEST.in | 1 +
README | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+)
diff --git a/MANIFEST.in b/MANIFEST.in
index 9c43888..b127f11 100644
@@ -1,4 +1,5 @@
recursive-include systemd *
recursive-include scripts *
diff --git a/README b/README
index e69de29..9e115f0 100644
@@ -0,0 +1,57 @@
+Initial Setup is an application that can run during the first start
+of a newly installed computer and makes it possible to configure the
+computer according to better serve the needs of the user.
+As most os the configuration options are already present during the
+OS installation in Anaconda, Initial Setup mainly host options that
+can need to be presented during the first start, such as displaying the
+EULA on RHEL. Initial Setup is also often used to create a user
+as many systems are often automatically installed with kickstart
+and the user is only expected to create their own user account.
+Still, while Initial Setup normally indeed does not have many options
+available, if the firstboot --recofing kickstart command is provided
+during the installation, Initial Setup will provide all configuration
+options available. This is usually used for the so called OEM installation
+where an OEM installs the computer, which is then shipped to the end user
+which uses Initial Setup for the final configuration according to their
+Initial Setup is basically just a thin wrapper for running spokes from Anaconda.
+Still, it has its own Hub, one spoke (the EULA spoke) and a translation domain ("initial-setup").
+As with Anaconda, Initial Setup has both a GUI and TUI version and the package is split
+to a core and GUI & TUI sub packages.
+As Initial Setup needs to run during the early boot, it is started by a systemd unit
+configured to start before the normal login screen. On RHEL7 Initial Setup is by default
+followed by the legacy Firstboot utility, which hosts the Subscription Manager plugin.
+If the given OS instance uses the Gnome 3 desktop environment Firstboot is followed by
+the Gnome Initial Setup, that enables the user to customize their computer even more.
+On Fedora Initial Setup is followed directly by GIS, provided Gnome 3 is installed.
+* RHEL7: IS -> Firstboot -> [GIS]
+* Fedora: IS -> [GIS]
+Just as Anaconda, also Initial Setup can be used to host third party addons - flexible
+yet powerful modules that can configure the system based on data in kickstart
+while presenting a nice UI to the user. Addons can have a GUI, TUI or can be even
+headless, working only with data in their kickstart section or from other sources.
+For a comprehensive documentation about Anaconda/Intial Setup see the
+"Anaconda Addon Development Guide" from Vratislav Podzimek:
+* Initial Setup is released under GPLv2+
+* upstream source code repository is on Fedorahosted: https://git.fedorahosted.org/git/initial-setup.git
+* for patch review Initial Setup uses the Anaconda Patches mailing list: https://lists.fedorahosted.org/mailman/listinfo/anaconda-patches
+ (please note that you need to be subscribed to the list to send patches, due to previous issues with SPAM on the list)
More information about the anaconda-patches