jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix layout

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-06 18:56:48 +02:00
parent 7c0698e36f
commit ffc292b069
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/developers/development_environment.markdown
View File

@ -11,25 +11,28 @@ footer: true
You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.
1. Visit the [the Home Assistant repository](https://github.com/home-assistant/home-assistant) and click "fork."
* Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**.
* Consider setting up a virtual environment using [`venv`](https://docs.python.org/3.4/library/venv.html) before running the setup script.
* Consider setting up a virtual environment using [`venv`](https://docs.python.org/3.4/library/venv.html) before running the setup script.
```bash
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
$ cd home-assistant
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
$ script/setup
```
* On Windows, you can use `python setup.py develop` instead of the setup script.
```bash
$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
$ cd home-assistant
$ git remote add upstream https://github.com/home-assistant/home-assistant.git
$ script/setup
```
2. Run `hass` to invoke your local installation.
* On Windows, you can use `python setup.py develop` instead of the setup script.
* Run `hass` to invoke your local installation.
### {% linkable_title Developing on Windows %}
### Developing on Windows
If you are using Windows as a development platform, make sure that you have the correct Microsoft Visual C++ build tools installed. Check the [Windows Compilers](https://wiki.python.org/moin/WindowsCompilers) section on the [Python website](https://www.python.org/) for details. Validation using `tox` will fail if this is not done correctly.
Also, make sure to install or upgrade the `Setuptools` Python package -- it contains compatibility improvements and adds automatic use of compilers:
```bash
pip install --upgrade setuptools
```
Also, make sure to install or upgrade the `setuptools` Python package. It contains compatibility improvements and adds automatic use of compilers:
```bash
$ pip install --upgrade setuptools
```