blob: 3a0b03ba759a49c80e8c808fe556f1bf26b123fa [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)
Song Guo2090fbe2020-12-11 00:26:35 +08007- Documentation about running [cirque](https://github.com/openweave/cirque)
8 tests can be found in
Andrei Litvin09bfa9d2021-05-27 18:37:10 -04009 [the cirque test guide](src/test_driver/linux-cirque/README.md)
Justin Wood0a9545e2020-04-20 18:15:21 -070010- 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)
Justin Wood88c84262020-04-01 15:20:03 +000013
14## Project Flow
15
clapre20002092021-05-28 17:15:42 -040016- Documentation about general project usage of GitHub, and project tools is
Justin Wood0a9545e2020-04-20 18:15:21 -070017 documented in [the project flow](./PROJECT_FLOW.md)
Justin Wood88c84262020-04-01 15:20:03 +000018
19## Style Guide
20
Justin Wood0a9545e2020-04-20 18:15:21 -070021- 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/)
Justin Wood88c84262020-04-01 15:20:03 +000025
Justin Woode19107e2020-04-01 17:59:52 +000026## Third Party Tools
27
28Some tools and utilities are dependent on third party tools, such as Docker.
29
Justin Wood0a9545e2020-04-20 18:15:21 -070030[Docker](https://www.docker.com) is an excellent way to have stable build
31environments that don't pollute the host OS. It is also much easier to maintain
32stability across multiple host environments. Install stable version of
33[Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to
Rob Walker00c01602020-10-14 18:55:02 -070034your native OS (macOS or Windows). Once installed, you can run docker commands
Justin Wood0a9545e2020-04-20 18:15:21 -070035from the shell/terminal.