On Fri, 2014-09-26 at 08:09 -0400, Anne Mulhern wrote:
----- Original Message -----
From: "Martin Kolman" <mkolman(a)redhat.com>
To: anaconda-patches(a)lists.fedorahosted.org
Sent: Thursday, September 25, 2014 3:19:21 PM
Subject: [initial-setup][rhel7-branch/master][PATCH] Populate README (#1110178)
Resolves: rhbz#1110178
Signed-off-by: Martin Kolman <mkolman(a)redhat.com>
---
MANIFEST.in | 1 +
README | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+)
diff --git a/MANIFEST.in b/MANIFEST.in
index 9c43888..b127f11 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,4 +1,5 @@
include COPYING
+include README.rst
include Makefile
recursive-include systemd *
recursive-include scripts *
diff --git a/README b/README
index e69de29..9e115f0 100644
--- a/README
+++ b/README
@@ -0,0 +1,57 @@
+Initial Setup
+=============
+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.
"according to better"...looks like you changed ideas in the middle of the
sentence.
+
+As most os the configuration options are already present during the
os -> of
+OS installation in Anaconda, Initial Setup mainly host options that
host -> manages OR hosts
+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.
I actually don't understand sentence above.
AFAIK, in some places, such as in universities, they let the users
self-install their machines by providing a kickstart that contains all
needed configuration options, but no user account specification.
So they just start the installation following the official instructions,
it does everything automatically and the only thing they are asked is
to create their user account on the first start, which is handled by
Initial Setup. The first phase might even be handled by local IT
and the users are only expected to start their computer and configure
their user account.
+
+Still, while Initial Setup normally indeed does not have many options
You should omit "indeed" above.
+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
"so called" should probably be skipped here. Its secondary meaning,
"used to express one's view that a name or term is inappropriate" has
nearly
become it's primary meaning.
+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
+need.
+
Skip "according to their need" or change "need" to
"needs".
+Architecture
+============
+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]
+
+Addons
+======
+Just as Anaconda, also Initial Setup can be used to host third party addons - flexible
Try: "Like Anaconda, Initial Setup can be used..."
+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
Skip "even" or put it before the be as "even be".
+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:
+
from -> by
+*
https://vpodzime.fedorapeople.org/anaconda-addon-development-guide/
+
+Contributing
+============
+* 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)
Thanks, fixing locally! :)