Skip to content

Commit

Permalink
Initial Stab
Browse files Browse the repository at this point in the history
  • Loading branch information
woody-apple committed Apr 1, 2020
1 parent 3e26f05 commit 88c8426
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

All documentation is inside of the [docs section](./docs/README.md)

Additional build information can also be found in [BUILDING.md](./BUILDING.md).
Instructions about how to build and develop CHIP can be found [here](./docs/README.md#BuildingandDeveloping).

# Need help?

Expand Down
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# Documentation

## Building and Developing

* Documentation about building from the command line can be found in [the build guide](./BUILDING.md)
* Documentation about standard build & development flows using [Visual Studio Code](https://code.visualstudio.com/) can be found in [the development guide](./VSCODE_DEVELOPMENT.md)

## Project Flow

* Documentation about general CHIP usage of GitHub, and project tools is documented in [the project flow](./PROJECT_FLOW.md)

## Style Guide

* Documentation about style is documented in [the style guide](./STYLE_GUIDE.md)
* Additional documentation about more specific files are in the [style folder](./style/)

33 changes: 33 additions & 0 deletions docs/VSCODE_DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Visual Studio Code Development

[Visual Studio Code](https://code.visualstudio.com/) is a great and simple IDE that can be used to build & develop with for CHIP.

CHIP supports the docker / remote container workflow that Visual Studio Code, and has an container environment setup automatically. You can read more about this workflow [here](https://code.visualstudio.com/docs/remote/containers).

Tested on:
* MacOS

## Setup Steps

1. Install [Docker](https://www.docker.com/) for your operating system of choice from here: <https://docs.docker.com/install>
1. Install [Visual Studio Code](https://code.visualstudio.com/) for your operating system of choice here: <https://code.visualstudio.com/Download>
1. Install [Git](https://git-scm.com/) if you haven't already
1. Git clone the main CHIP repository here: <https://github.com/project-chip/connectedhomeip>
1. Launch Visual Studio Code, and open the cloned folder from
1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for Visual Studio Code, this extension allows you to use docker containers as a development backend.
1. Once this is installed, you'll be prompted to reload Visual Studio Code, do so
1. At the bottom right of your Visual Studio Code window you should have a new box prompting you to re-open the window as a container. Hit yes.
1. Now your local machine is building a docker image that has all the tools necessary to build and test CHIP. This can take some time, but will eventually complete and open up the source tree

## Bootstrapping your source tree (one time)
1. Under the "Terminal" menu (or using another shortcut to the same tool), select "Run Task..."
1. Select the "Bootstrap" task

## Building the Source Tree
1. Under the "Terminal" menu select "Run Build Task..."

## Tasks

Located in the [tasks json](../.vscode/tasks.json) file you'll find a list of tasks that can be run from the "Run Task..." command.
Example tasks are "Clean", "Run Pretty Check"

6 changes: 6 additions & 0 deletions docs/style/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Style

When necessary to drive into more detail about styles about specific types of files this is where CHIP collects them

## Specific Types
* [Makefiles](./STYLE_MAKEFILES.md)

0 comments on commit 88c8426

Please sign in to comment.