Skip to content
Snippets Groups Projects
README.md 1.17 KiB
Newer Older
Justin Wood's avatar
Justin Wood committed
# Documentation
Justin Wood's avatar
Justin Wood committed

## 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)
Justin Wood's avatar
Justin Wood committed

## Project Flow

-   Documentation about general CHIP usage of GitHub, and project tools is
    documented in [the project flow](./PROJECT_FLOW.md)
Justin Wood's avatar
Justin Wood committed

## 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/)
Justin Wood's avatar
Justin Wood committed

Justin Wood's avatar
Justin Wood committed
## Third Party Tools

Some tools and utilities are dependent on third party tools, such as Docker.

[Docker](https://www.docker.com) is an excellent way to have stable build
environments that don't pollute the host OS. It is also much easier to maintain
stability across multiple host environments. Install stable version of
[Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to
your native OS (MacOS or Windows). Once installed, you can run docker commands
from the shell/terminal.