docs/README.md

   1 # Documentation
   2
   3 ## Building and Developing
   4
   5 -   Documentation about building from the command line can be found in
   6     [the build guide](./BUILDING.md)
   7 -   Documentation about running [cirque](https://github.com/openweave/cirque)
   8     tests can be found in
   9     [the cirque test guide](src/test_driver/linux-cirque/README.md)
  10 -   Documentation about standard build & development flows using
  11     [Visual Studio Code](https://code.visualstudio.com/) can be found in
  12     [the development guide](./VSCODE_DEVELOPMENT.md)
  13
  14 ## Project Flow
  15
  16 -   Documentation about general CHIP usage of GitHub, and project tools is
  17     documented in [the project flow](./PROJECT_FLOW.md)
  18
  19 ## Style Guide
  20
  21 -   Documentation about style is documented in
  22     [the style guide](./STYLE_GUIDE.md)
  23 -   Additional documentation about more specific files are in the
  24     [style folder](./style/)
  25
  26 ## Third Party Tools
  27
  28 Some tools and utilities are dependent on third party tools, such as Docker.
  29
  30 [Docker](https://www.docker.com) is an excellent way to have stable build
  31 environments that don't pollute the host OS. It is also much easier to maintain
  32 stability across multiple host environments. Install stable version of
  33 [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to
  34 your native OS (macOS or Windows). Once installed, you can run docker commands
  35 from the shell/terminal.