From ffc292b069d5fdf8038bcd0998023a2d602ac2a2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 6 Oct 2016 18:56:48 +0200 Subject: [PATCH] Fix layout --- .../development_environment.markdown | 33 ++++++++++--------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/source/developers/development_environment.markdown b/source/developers/development_environment.markdown index 3e44e9f7f39..e25254537c7 100644 --- a/source/developers/development_environment.markdown +++ b/source/developers/development_environment.markdown @@ -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 +```