added html file
authorJean-Philippe Orsini <jeanfi@gmail.com>
Tue, 14 Jun 2016 10:08:49 +0000 (12:08 +0200)
committerJean-Philippe Orsini <jeanfi@gmail.com>
Tue, 14 Jun 2016 10:08:49 +0000 (12:08 +0200)
www/psensor/contribute.html [new file with mode: 0644]

diff --git a/www/psensor/contribute.html b/www/psensor/contribute.html
new file mode 100644 (file)
index 0000000..c8927d2
--- /dev/null
@@ -0,0 +1,173 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="generator" content="Asciidoctor 1.5.4">
+<title>How to contribute to psensor</title>
+<link rel="stylesheet" href="./../style.css">
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script>
+<script src="nav.js"></script>
+</head>
+<body class="article">
+<div id="header">
+<h1>How to contribute to psensor</h1>
+</div>
+<div id="content">
+<div class="sect1">
+<h2 id="_translations">Translations</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Psensor is fully translatable, and contributions to the translation
+for any language are welcome.</p>
+</div>
+<div class="sect2">
+<h3 id="_directly_update_the_translation_files">Directly update the translation files</h3>
+<div class="paragraph">
+<p>You can modify the .po files which are available in the
+GIT repository: <a href="http://git.wpitchoune.net/psensor.git" class="bare">http://git.wpitchoune.net/psensor.git</a> and send it to
+<a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p>
+</div>
+<div class="paragraph">
+<p><a href="http://poedit.net">poedit</a> or any text editors supporting UTF-8
+can be used to edit the translation files .</p>
+</div>
+<div class="paragraph">
+<p>If the <code>.po</code> file does not exist for your language, send me an email, I
+will add it.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_use_launchpad">Use Launchpad</h3>
+<div class="admonitionblock warning">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Warning</div>
+</td>
+<td class="content">
+Currently, you must NOT use this way. Due to a <a href="https://bugs.launchpad.net/ubuntu/+source/bzr-git/+bug/1084403">bug</a> which
+prevents to import GIT repository to Bazaar branch, it is impossible
+to synchronize the translations.
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>The easiest way is probably to use the Launchpad translation Web
+service available at:
+<a href="https://translations.launchpad.net/psensor/trunk/+translations" class="bare">https://translations.launchpad.net/psensor/trunk/+translations</a>.</p>
+</div>
+<div class="paragraph">
+<p>If you did not already use it, you can read some documentation at:
+<a href="https://help.launchpad.net/Translations" class="bare">https://help.launchpad.net/Translations</a>. The LP translations are
+periodically merged in the Psensor source repository and systematicaly
+before each release.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_source_code">Source code</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Patch fixing bugs or adding features are welcome.</p>
+</div>
+<div class="paragraph">
+<p>The code modification must be submitted as a patch file on the SVN
+‘trunk’:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Checkout the source code: <code>git clone <a href="http://git.wpitchoune.net/psensor.git" class="bare">http://git.wpitchoune.net/psensor.git</a></code></p>
+</li>
+<li>
+<p>Modify the files</p>
+</li>
+<li>
+<p>Generate the patch file: <code>git diff &gt;/tmp/mypatch.diff</code></p>
+</li>
+<li>
+<p>Verify that it respects the coding style: <code>make check</code></p>
+</li>
+<li>
+<p>Send the patch file by email to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a></p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>If it concerns a bug which does not exist on the ‘master’ GIT branch,
+the patch must be done on the appropriate GIT branch:
+<a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary" class="bare">http://git.wpitchoune.net/gitweb/?p=psensor.git;a=summary</a>.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_icons">Icons</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Psensor is using 3 differents icons:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor.svg;hb=HEAD">an application icon</a></p>
+</li>
+<li>
+<p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=blob_plain;f=icons/hicolor/scalable/psensor_normal.svg;hb=HEAD">a status icon</a></p>
+</li>
+<li>
+<p><a href="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</a></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>and provides icons for 3 different themes:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/hicolor/scalable;hb=HEAD">hicolor, the default theme for most desktop environment</a></p>
+</li>
+<li>
+<p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-dark;hb=HEAD">the default ubuntu monochrome dark theme</a></p>
+</li>
+<li>
+<p><a href="http://git.wpitchoune.net/gitweb/?p=psensor.git;a=tree;f=icons/ubuntu-mono-light;hb=HEAD">the default ubuntu monochrome light theme</a></p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>The status icons for Ubuntu themes have been provided by Christoph
+Buchner and are nice but definitively not the application icon.</p>
+</div>
+<div class="paragraph">
+<p>Contributions to the icons are welcome for the already existent themes
+or others. To submit a new icon it must:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>be an original work (not confusing with another application icons)
+and released under GPL v2 license.</p>
+</li>
+<li>
+<p>use the .SVG format.</p>
+</li>
+<li>
+<p>be sent to me by email (<a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>).</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2016-06-14 12:08:22 CEST
+</div>
+</div>
+</body>
+</html>
\ No newline at end of file