From 8116e9bb26f5a0c6be1540c6e75c614b8fef4a87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Fri, 19 Jul 2019 20:15:29 +0200 Subject: [PATCH] Add notes about devcontainer (#294) * Add notes about devcontainer * corrected typos * :pencil2: Tweaks --- docs/development_environment.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/development_environment.md b/docs/development_environment.md index 47481020..363d018c 100644 --- a/docs/development_environment.md +++ b/docs/development_environment.md @@ -69,6 +69,33 @@ Then install ffmpeg: $ brew install ffmpeg ``` +### Developing with devcontainer + +The devcontainer is a preconfigured development environment with all the tools you need. + +**Prerequisites** + +- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +- [Docker](https://docs.docker.com/install/) +- [Visual Studio code](https://code.visualstudio.com/) +- [Remote - Containers (VSC Extension)](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + +[More info about requirements and devcontainer in general](https://code.visualstudio.com/docs/remote/containers#_getting-started) + +**Getting started:** + +1. Fork the repository. +1. Clone the repository to your computer. +1. Open the repository using Visual Studio code. + +When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container. + +_If you don't see this notification, open the command pallet and select `Remote-Containers: Reopen Folder in Container`._ + +The devcontainter comes with some useful tasks to help you with development, you can start these tasks by opening the command pallet and select `Tasks: Run Task` then select the task you want to run. + +Running tasks like `Preview` can be restarted by opening the command pallet and selecting `Tasks: Restart Running Task`, then select the task you want to restart. + ## Setup Local Repository Visit the [Home Assistant repository](https://github.com/home-assistant/home-assistant) and click **Fork**.