[PATCH 2/2] Add the rst suffix to the README file

Samantha N. Bueno sbueno+anaconda at redhat.com
Wed Feb 4 15:36:48 UTC 2015


Just a few small fixes inline....

On Wed, Feb 04, 2015 at 03:49:01PM +0100, Martin Kolman wrote:
> The README file is using the reStructuredText syntax
> and adding the .rst extension makes GitHub properly
> render the formating in the browser.
> 
> Signed-off-by: Martin Kolman <mkolman at redhat.com>
> ---
>  README     | 57 ---------------------------------------------------------
>  README.rst | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 57 insertions(+), 57 deletions(-)
>  delete mode 100644 README
>  create mode 100644 README.rst
> 
> diff --git a/README b/README
> deleted file mode 100644
> index 4ae6dbc..0000000
> --- a/README
> +++ /dev/null
> @@ -1,57 +0,0 @@
> -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 the needs of the user.
> -
> -As most of the configuration options are already present during the
> -OS installation in Anaconda, Initial Setup mainly hosts options that
> -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 account,
> -as many systems are often automatically installed with kickstart
> -and the user is only expected to create their own user account once
> -the newly installed machine is started for the first time.
> -
> -Still, while Initial Setup normally does not have many options
> -available, if the firstboot --recofing kickstart command is provided
> -in the installation kickstart, Initial Setup will show all configuration
> -options available. This is usually used for OEM OS installations,
> -where an OEM installs the computer, which is then shipped to the end user
> -which uses Initial Setup for the final configuration of the operating system.
> -
> -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, which 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
> -======
> -Like 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
> -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" by Vratislav Podzimek:
> -
> -* https://vpodzime.fedorapeople.org/anaconda-addon-development-guide/
> -
> -Contributing
> -============
> -* Initial Setup is released under GPLv2+
> -* upstream source code repository is on GitHub: https://github.com/rhinstaller/initial-setup
> -* 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)
> diff --git a/README.rst b/README.rst
> new file mode 100644
> index 0000000..4ae6dbc
> --- /dev/null
> +++ b/README.rst
> @@ -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 the needs of the user.
> +
> +As most of the configuration options are already present during the
> +OS installation in Anaconda, Initial Setup mainly hosts options that
> +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 account,
> +as many systems are often automatically installed with kickstart
> +and the user is only expected to create their own user account once
> +the newly installed machine is started for the first time.
> +
> +Still, while Initial Setup normally does not have many options
> +available, if the firstboot --recofing kickstart command is provided
                                ^ reconfig
> +in the installation kickstart, Initial Setup will show all configuration
> +options available. This is usually used for OEM OS installations,
> +where an OEM installs the computer, which is then shipped to the end user
> +which uses Initial Setup for the final configuration of the operating system.
> +
> +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.
   ^into
> +
> +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, which 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
> +======
> +Like 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
> +headless, working only with data in their kickstart section or from other sources.
> +
> +For a comprehensive documentation about Anaconda/Intial Setup see the
       ^no "a"
> +"Anaconda Addon Development Guide" by Vratislav Podzimek:
> +
> +* https://vpodzime.fedorapeople.org/anaconda-addon-development-guide/
> +
> +Contributing
> +============
> +* Initial Setup is released under GPLv2+
> +* upstream source code repository is on GitHub: https://github.com/rhinstaller/initial-setup
> +* 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)

Other than the typos, Ack to this and the first.

> -- 
> 2.1.0
> 
> _______________________________________________
> anaconda-patches mailing list
> anaconda-patches at lists.fedorahosted.org
> https://lists.fedorahosted.org/mailman/listinfo/anaconda-patches


More information about the anaconda-patches mailing list