From 88c84260dac7aa07cde3a5dfb2ee06918766762f Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Wed, 1 Apr 2020 15:20:03 +0000 Subject: [PATCH] Initial Stab --- README.md | 2 +- BUILDING.md => docs/BUILDING.md | 0 docs/README.md | 15 +++++++++++++++ docs/VSCODE_DEVELOPMENT.md | 33 +++++++++++++++++++++++++++++++++ docs/style/README.md | 6 ++++++ 5 files changed, 55 insertions(+), 1 deletion(-) rename BUILDING.md => docs/BUILDING.md (100%) create mode 100644 docs/VSCODE_DEVELOPMENT.md create mode 100644 docs/style/README.md diff --git a/README.md b/README.md index 03edc5fc9a9160..e267d8dedafcd0 100644 --- a/README.md +++ b/README.md @@ -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? diff --git a/BUILDING.md b/docs/BUILDING.md similarity index 100% rename from BUILDING.md rename to docs/BUILDING.md diff --git a/docs/README.md b/docs/README.md index 25f8d456418b55..0d7a1263c2345e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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/) + diff --git a/docs/VSCODE_DEVELOPMENT.md b/docs/VSCODE_DEVELOPMENT.md new file mode 100644 index 00000000000000..cda75a158dd834 --- /dev/null +++ b/docs/VSCODE_DEVELOPMENT.md @@ -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: +1. Install [Visual Studio Code](https://code.visualstudio.com/) for your operating system of choice here: +1. Install [Git](https://git-scm.com/) if you haven't already +1. Git clone the main CHIP repository here: +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" + diff --git a/docs/style/README.md b/docs/style/README.md new file mode 100644 index 00000000000000..890578a55f2f60 --- /dev/null +++ b/docs/style/README.md @@ -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)