Skip to content

Commit 9126614

Browse files
Update codespace doc and include default debug setting.
1 parent 946f65b commit 9126614

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,5 @@ docs/site
2929

3030

3131
!.vscode/settings.json
32+
!.vscode/launch.json
3233
!.devcontainer/devcontainer.json

.vscode/launch.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Python: Current File",
9+
"type": "python",
10+
"request": "launch",
11+
"program": "${file}",
12+
"console": "integratedTerminal",
13+
"justMyCode": false
14+
}
15+
]
16+
}

docs/src/develop.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ Included with the codebase is the recommended development environment configured
66

77
Here are some options that provide a great developer experience:
88

9-
- **Cloud-based IDE**: (*recommended*) Launch using the [GitHub Codespaces](https://github.com/features/codespaces) named `Development`.
9+
- **Cloud-based IDE**: (*recommended*)
10+
- Launch using [GitHub Codespaces](https://github.com/features/codespaces) using the option `Create codespace on master` in the codebase repository.
11+
- Build time for a 2-Core codespace is **~5m**. This is done infrequently and cached for convenience.
12+
- Start time for a 2-Core codespace is **~1m**. This will pull the built codespace from cache when you need it.
13+
- Tip: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
1014
- **Local IDE**:
1115
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1216
- Ensure you have [Docker](https://docs.docker.com/get-docker/)

0 commit comments

Comments
 (0)