jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2015-09-01 08:42:54 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-09-01 01:42:54 -07:00
parent 2e727a5332
commit 5a20d28e54
77 changed files with 4485 additions and 1421 deletions
Download patch file Download diff file Expand all files Collapse all files

52
developers/index.html
View file

@ -104,9 +104,57 @@
<hr class="divider">
<p>Home Assistant is build from the ground-up to be easily extensible by other developers using components. It uses <a href="https://www.python.org/">Python 3</a> for the backend and <a href="https://www.polymer-project.org/">Polymer (Webcomponents)</a> for the frontend.</p>
<p>Home Assistant is build from the ground-up to be easily extensible by other developers using
components. It uses <a href="https://www.python.org/">Python 3</a> for the backend and
<a href="https://www.polymer-project.org/">Polymer (Webcomponents)</a> for the frontend.</p>
<p>For further reading, see:</p>
<p>Home Assistant is open-source and MIT licensed. The source can be found here:</p>
<ul>
<li><a href="https://github.com/home-assistant">home-assistant</a> - Python server-backend</li>
<li><a href="https://github.com/home-assistant-js">home-assistant-js</a> - javascript-backend powering the client</li>
<li><a href="https://github.com/home-assistant-polymer">home-assistant-polymer</a> - Polymer UI</li>
</ul>
<h3><a class='title-link' name='starting-development' href='#starting-development'></a> Starting development</h3>
<p>You will need to setup a development environment if you want to start developing a new feature or
component for Home Assistant.</p>
<ol>
<li>Clone the Home Assistant repository:<br>
<code>git clone https://github.com/balloob/home-assistant.git</code></li>
<li>Setup your computer for development:<br>
<code>python3 setup.py develop</code></li>
</ol>
<p>After following these steps, running <code>hass</code> will invoke your local installation.</p>
<h3><a class='title-link' name='submitting-improvements' href='#submitting-improvements'></a> Submitting improvements</h3>
<p>Improvements to Home Assistant should be submitted one feature at a time using Github pull
requests.</p>
<ol>
<li>Go to <a href="https://github.com/balloob/home-assistant">the Home Assistant repository</a>
and click fork in the top right.</li>
<li>Follow steps in the previous section but with your forked repository.</li>
<li>Create a new branch to hold your changes<br>
<code>git checkout -b some-feature</code></li>
<li>Make the changes you want</li>
<li>Commit the changes<br>
<code>git add .</code><br>
<code>git commit -m "Added some-feature"</code></li>
<li>Push your commited changes back to your fork on Github<br>
<code>git push origin HEAD</code></li>
<li>Follow <a href="https://help.github.com/articles/creating-a-pull-request/">these steps</a> to create your
pull request.</li>
</ol>
<h3><a class='title-link' name='further-reading' href='#further-reading'></a> Further reading</h3>
<ul>
<li><a href="/developers/architecture.html">