X-Git-Url: http://git.wpitchoune.net/gitweb/?p=www.git;a=blobdiff_plain;f=src%2Fpsensor%2Fcontribute.adoc;fp=src%2Fpsensor%2Fcontribute.adoc;h=5036596832e443773d6c22673d3bb9cbf9fd233d;hp=0000000000000000000000000000000000000000;hb=9bdd8db1868af6edb061bc663934e315c3d2cef6;hpb=26f86ab42cc5777657005a7d2f96ff06f480eb64

diff --git a/src/psensor/contribute.adoc b/src/psensor/contribute.adoc
new file mode 100644
index 0000000..5036596
--- /dev/null
+++ b/src/psensor/contribute.adoc
@@ -0,0 +1,87 @@
+= How to contribute to psensor
+:docinfo2:
+
+== Translations
+
+Psensor is fully translatable, and contributions to the translation
+for any language are welcome.
+
+=== Directly update the translation files
+
+You can modify the .po files which are available in the
+GIT repository: http://git.wpitchoune.net/psensor.git and send it to
+jeanfi@gmail.com.
+
+link:http://poedit.net[poedit] or any text editors supporting UTF-8
+can be used to edit the translation files .
+
+If the `.po` file does not exist for your language, send me an email, I
+will add it.
+
+=== Use Launchpad
+
+WARNING: Currently, you must NOT use this way. Due to a link:https://bugs.launchpad.net/ubuntu/+source/bzr-git/+bug/1084403[bug] which
+prevents to import GIT repository to Bazaar branch, it is impossible
+to synchronize the translations.
+
+The easiest way is probably to use the Launchpad translation Web
+service available at:
+https://translations.launchpad.net/psensor/trunk/+translations.
+
+If you did not already use it, you can read some documentation at:
+https://help.launchpad.net/Translations. The LP translations are
+periodically merged in the Psensor source repository and systematicaly
+before each release.
+
+== Source code
+
+Patch fixing bugs or adding features are welcome.
+
+The code modification must be submitted as a patch file on the SVN
+‘trunk’:
+
+. Checkout the source code: `git clone http://git.wpitchoune.net/psensor.git`
+
+. Modify the files
+
+. Generate the patch file: `git diff >/tmp/mypatch.diff`
+
+. Verify that it respects the coding style: `make check`
+
+. Send the patch file by email to jeanfi@gmail.com
+
+If it concerns a bug which does not exist on the ‘master’ GIT branch,
+the patch must be done on the appropriate GIT branch:
+http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary.
+
+== Icons
+
+Psensor is using 3 differents icons:
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor.svg;hb=HEAD[an application icon]
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_normal.svg;hb=HEAD[a status icon]
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_hot.svg;hb=HEAD[a status icon when there is a sensor alert]
+
+and provides icons for 3 different themes:
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/hicolor/scalable;hb=HEAD[hicolor, the default theme for most desktop environment]
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-dark;hb=HEAD[the default ubuntu monochrome dark theme]
+
+* link:http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-light;hb=HEAD[the default ubuntu monochrome light theme]
+
+The status icons for Ubuntu themes have been provided by Christoph
+Buchner and are nice but definitively not the application icon.
+
+Contributions to the icons are welcome for the already existent themes
+or others. To submit a new icon it must:
+
+* be an original work (not confusing with another application icons)
+  and released under GPL v2 license.
+
+* use the .SVG format.
+
+* be sent to me by email (jeanfi@gmail.com).
+