Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
genosse-einhorn committed Oct 26, 2013
1 parent 25e49b5 commit 01d3ec7
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,37 @@ It's based on patches made by Giovanni Campagna: https://bugzilla.gnome.org/show
* ClassicMenu Indicator takes ages to load and has been reported to freeze the shell forever. This is probably caused by the insane amount of embedded PNG icons. Try at your own risk.
* Embedded PNG icon data in menus (as used by Skype, ClassicMenu Indicator and others) can only be handled efficiently in recent gjs versions. Older versions (notably Ubuntu 12.10) will have to use a very ugly and inefficient method.

## Installation
Normal users are recommended to get the extension from [extensions.gnome.org](https://extensions.gnome.org/extension/615/appindicator-support/).

Alternatively, you can check out a version from git. Make sure you have `glib-compile-schemas` (comes with glib development packages)
and gettext utilities (`msgformat`, `msgmerge`, `xgettext` - might also be included in glib dev packages) installed.

1. Create a clone of the repo. Do **not** use zip files or release tarballs. We need git metadata during the build.
2. Run `make`.
3. Symlink `~/.local/share/gnome-shell/extensions/appindicatorsupport@rgcjonas.gmail.com` to your clone.
4. Restart the Shell (`alt+f2`, `r`, ``).
5. Enable the extension in `gnome-tweak-tool`.

## Guidelines for bug reports
Since I'm tired of useless reports, you need to provide:
* Your distribution (e.g. "Ubuntu 13.04")
* Your version of GNOME Shell (e.g. "3.6.3")
* The version of the extension (e.g. "v1 from extensions.gnome.org" or "latest git")
* The involved indicator applets (e.g. "My Weather Indicator 0.6.1")
* Detailed description of the bug with instructions how to reproduce it
Unfortunately, this extension is not completely bug free and will probably never be.
In order to successfully resolve the issues you need to provide some data:

* Your distribution, Shell version and extension version (something like "latest git" or "latest from extensions.gnome.org" is sufficient).

Starting from extension version v10, you can get this all by clicking "Copy debug information" on the "About" tab in the settings screen.
You may of course shorten it a bit if you consider the "uname -a" output a privacy breach.
* The indicator that caused the bug (if applicable)
* Instructions how to reproduce it. **This is the single most important point**. Bugs that [can't be reproduced](http://xkcd.com/583/) can't be fixed either.

Bugs which don't provide the necessary information may be closed as "invalid" without prior notice.

## TODO
* Add Localization (You can help there!).
## Release process
This section serves as reminder for the current maintainer and as instruction set for an eventual sucessor.

* The maintainer decides when to release a new version.
* Versions are tagged (and signed). Version numbers sould be kept in sync with the versions submitted to `extensions.gnome.org`.
This implies that version numbers are integers that will be incremented which each release.
* The maintainer will tag a new version and the do a `make clean; make zip` to generate the zip file which is immediately uploaded to `extensions.gnome.org`

This release process has been in place since v9.

0 comments on commit 01d3ec7

Please sign in to comment.