blob: 531df56015dd5f8f831d3c67d97c99bf9e5b7a1b [file] [log] [blame] [view]
Justin Woodc9bbb252020-03-03 10:03:58 -08001# Documentation
Justin Wood88c84262020-04-01 15:20:03 +00002
3## Building and Developing
4
Justin Wood0a9545e2020-04-20 18:15:21 -07005- Documentation about building from the command line can be found in
6 [the build guide](./BUILDING.md)
7- Documentation about standard build & development flows using
8 [Visual Studio Code](https://code.visualstudio.com/) can be found in
9 [the development guide](./VSCODE_DEVELOPMENT.md)
Justin Wood88c84262020-04-01 15:20:03 +000010
11## Project Flow
12
Justin Wood0a9545e2020-04-20 18:15:21 -070013- Documentation about general CHIP usage of GitHub, and project tools is
14 documented in [the project flow](./PROJECT_FLOW.md)
Justin Wood88c84262020-04-01 15:20:03 +000015
16## Style Guide
17
Justin Wood0a9545e2020-04-20 18:15:21 -070018- Documentation about style is documented in
19 [the style guide](./STYLE_GUIDE.md)
20- Additional documentation about more specific files are in the
21 [style folder](./style/)
Justin Wood88c84262020-04-01 15:20:03 +000022
Justin Woode19107e2020-04-01 17:59:52 +000023## Third Party Tools
24
25Some tools and utilities are dependent on third party tools, such as Docker.
26
Justin Wood0a9545e2020-04-20 18:15:21 -070027[Docker](https://www.docker.com) is an excellent way to have stable build
28environments that don't pollute the host OS. It is also much easier to maintain
29stability across multiple host environments. Install stable version of
30[Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to
31your native OS (MacOS or Windows). Once installed, you can run docker commands
32from the shell/terminal.