Justin Wood | c9bbb25 | 2020-03-03 10:03:58 -0800 | [diff] [blame] | 1 | # Documentation |
Justin Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 2 | |
| 3 | ## Building and Developing |
| 4 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 5 | - 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 Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 10 | |
| 11 | ## Project Flow |
| 12 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 13 | - Documentation about general CHIP usage of GitHub, and project tools is |
| 14 | documented in [the project flow](./PROJECT_FLOW.md) |
Justin Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 15 | |
| 16 | ## Style Guide |
| 17 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 18 | - 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 Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 22 | |
Justin Wood | e19107e | 2020-04-01 17:59:52 +0000 | [diff] [blame] | 23 | ## Third Party Tools |
| 24 | |
| 25 | Some tools and utilities are dependent on third party tools, such as Docker. |
| 26 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 27 | [Docker](https://www.docker.com) is an excellent way to have stable build |
| 28 | environments that don't pollute the host OS. It is also much easier to maintain |
| 29 | stability across multiple host environments. Install stable version of |
| 30 | [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to |
| 31 | your native OS (MacOS or Windows). Once installed, you can run docker commands |
| 32 | from the shell/terminal. |