enhance documentation

1 files changed, 48 insertions, 7 deletions

diff --git a/README.md b/README.md
index 9e16bfd..6f17836 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,56 @@
 
 ## About gfxboot
 
-Graphical boot screen test and configuration tool. For general usage, see
-`gfxboot` manual page.
+gfxboot is a graphical boot screen for syslinux (up to version 4) and grub1.
+
+Features
+
+  - editable boot options
+  - a menu system
+  - context sensitive help texts (in html) shown in separate windows
+  - support for different keyboard layouts
+  - i18n support (localization via po files, Unicode char rendering via freetype lib)
+  - text-to-speech support via pc-speaker
+  - can run animations and play wav files
+  - works via serial line (with text-based menus)
+
+## Downloads
+
+Get the latest version from the [openSUSE Build Service](https://software.opensuse.org/package/gfxboot).
+
+## Examples
+
+It is used by [openSUSE Tumbleweed](http://download.opensuse.org/tumbleweed/iso/openSUSE-Tumbleweed-DVD-x86_64-Current.iso). The boot screen looks like this:
+
+![openSUSE Tumbleweed boot screen](doc/suse.jpg)
+
+A more minimalistic [example](themes/example_07/example_07.bc) included in the git repository:
+
+![example boot screen](doc/example.jpg)
+
 
 ## openSUSE Development
 
-The package is automatically submitted from the `master` branch to
-[system:install:head](https://build.opensuse.org/package/show/system:install:head/gfxboot)
-OBS project. From that place it is forwarded to
-[openSUSE Factory](https://build.opensuse.org/project/show/openSUSE:Factory).
+To build, simply run `make`. Install with `make install`.
+
+Basically every new commit into the master branch of the repository will be auto-submitted
+to all current SUSE products. No further action is needed except accepting the pull request.
+
+Submissions are managed by a SUSE internal [jenkins](https://jenkins.io) node in the InstallTools tab.
+
+Each time a new commit is integrated into the master branch of the repository,
+a new submit request is created to the openSUSE Build Service. The devel project
+is [system:install:head](https://build.opensuse.org/package/show/system:install:head/gfxboot).
+
+`*.changes` and version numbers are auto-generated from git commits, you don't have to worry about this.
+
+The spec file is maintained in the Build Service only. If you need to change it for the `master` branch,
+submit to the
+[devel project](https://build.opensuse.org/package/show/system:install:head/gfxboot)
+in the build service directly.
+
+Development happens exclusively in the `master` branch. The branch is used for all current products.
 
-You can find more information about this workflow in the [linuxrc-devtools
+You can find more information about the changes auto-generation and the
+tools used for jenkis submissions in the [linuxrc-devtools
 documentation](https://github.com/openSUSE/linuxrc-devtools#opensuse-development).