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) |
Song Guo | 2090fbe | 2020-12-11 00:26:35 +0800 | [diff] [blame] | 7 | - Documentation about running [cirque](https://github.com/openweave/cirque) |
| 8 | tests can be found in |
Andrei Litvin | 09bfa9d | 2021-05-27 18:37:10 -0400 | [diff] [blame] | 9 | [the cirque test guide](src/test_driver/linux-cirque/README.md) |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 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) |
Justin Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 13 | |
| 14 | ## Project Flow |
| 15 | |
clapre | 2000209 | 2021-05-28 17:15:42 -0400 | [diff] [blame^] | 16 | - Documentation about general project usage of GitHub, and project tools is |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 17 | documented in [the project flow](./PROJECT_FLOW.md) |
Justin Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 18 | |
| 19 | ## Style Guide |
| 20 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 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/) |
Justin Wood | 88c8426 | 2020-04-01 15:20:03 +0000 | [diff] [blame] | 25 | |
Justin Wood | e19107e | 2020-04-01 17:59:52 +0000 | [diff] [blame] | 26 | ## Third Party Tools |
| 27 | |
| 28 | Some tools and utilities are dependent on third party tools, such as Docker. |
| 29 | |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 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 |
Rob Walker | 00c0160 | 2020-10-14 18:55:02 -0700 | [diff] [blame] | 34 | your native OS (macOS or Windows). Once installed, you can run docker commands |
Justin Wood | 0a9545e | 2020-04-20 18:15:21 -0700 | [diff] [blame] | 35 | from the shell/terminal. |