Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve dev container support #5

Merged
merged 32 commits into from
May 31, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
296f026
Update devcontainers
SergioGasquez May 25, 2022
684983a
Fix executable string
SergioGasquez May 25, 2022
df0fc20
Remove TODO
SergioGasquez May 25, 2022
ea05aa3
Update workwspace path
SergioGasquez May 25, 2022
3dec541
Add build, flash and wokwi scripts
SergioGasquez May 25, 2022
cebafed
Clean up build script
SergioGasquez May 25, 2022
c3f6cd1
Scripts clean up
SergioGasquez May 25, 2022
02f264e
Ignore scripts when not using devcontainers
SergioGasquez May 25, 2022
5544497
Update devcontainer question
SergioGasquez May 25, 2022
67b5a1c
Update CURRENT_PROJECT path
SergioGasquez May 26, 2022
d0f0f6a
Update environment in wokwi and flash scripts
SergioGasquez May 26, 2022
c69dc26
Use esp-idf v.4.4 to have gcc toolchains
SergioGasquez May 26, 2022
5293fdd
Clean up flash and wokwi scripts
SergioGasquez May 26, 2022
ca5a851
Clean up flash and wokwi scripts
SergioGasquez May 26, 2022
709bfac
Add Devcontainers documentation
SergioGasquez May 26, 2022
faea1c4
Improve format and fix typos
SergioGasquez May 26, 2022
2dcb80a
Improve format and fix typos
SergioGasquez May 26, 2022
7aea66f
Add warning for esp32s3 in wokwi
SergioGasquez May 26, 2022
6da14bc
Update risc gdb
SergioGasquez May 26, 2022
3f019ae
Update format
SergioGasquez May 26, 2022
875c267
Update README.md
SergioGasquez May 26, 2022
ddcd9b2
Use binaries for wokwi-server and web-flash
SergioGasquez May 30, 2022
ed31a3d
Add readme template
SergioGasquez May 30, 2022
b6c69b0
Update riscv gdb path
SergioGasquez May 30, 2022
648644e
Delete comment
SergioGasquez May 30, 2022
6d16367
Fix dev container name
SergioGasquez May 30, 2022
740e34e
Add note on wokwi simulation project
SergioGasquez May 30, 2022
e15a491
Move scripts to a folder and add image propierty
SergioGasquez May 31, 2022
a449906
Fix image propierty
SergioGasquez May 31, 2022
5fbf115
Fix scripts path
SergioGasquez May 31, 2022
2ec24ed
Update scripts to use project-name instead of crate-name
SergioGasquez May 31, 2022
6b11efc
Add python3-venv dependency which is now required for esp-idf master
SergioGasquez May 31, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move scripts to a folder and add image propierty
  • Loading branch information
SergioGasquez committed May 31, 2022
commit e15a4917e48a3addff2808fca34a53a4b4888ad2
2 changes: 2 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"name": "{{ crate_name }}",
// Select between image and build propieties to pull or build the image.
// "image": "docker.io/espressif/idf-rust:{{ mcu }}_v4.4_1.61.0.0"
"build": {
"dockerfile": "Dockerfile",
"args": {
Expand Down
6 changes: 3 additions & 3 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{
"label": "Build",
"type": "shell",
"command": "./build.sh ${input:buildMode}",
"command": "scripts/build.sh ${input:buildMode}",
"options": {
"cwd": "${workspaceFolder}"
},
Expand All @@ -16,7 +16,7 @@
{
"label": "Build & Flash",
"type": "shell",
"command": "./flash.sh ${input:buildMode}",
"command": "scripts/flash.sh ${input:buildMode}",
"options": {
"cwd": "${workspaceFolder}"
},
Expand All @@ -28,7 +28,7 @@
{
"label": "Build & Run Wokwi",
"type": "shell",
"command": "./run-wokwi.sh ${input:buildMode}",
"command": "scripts/run-wokwi.sh ${input:buildMode}",
"options": {
"cwd": "${workspaceFolder}"
},
Expand Down
10 changes: 7 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,17 @@ This repository offers Dev Containers supports for:
> the project needs to be published in a GitHub repository and the user needs
> to be part of the Codespaces beta or have the project under an organization.

If using VS Code or GitHub Codespaces, you can pull the image instead of building it
from the Dockerfile by selecting the `image` property instead of `build` in
`.devcontainer/devcontainer.json`

When using Dev Containers, some tooling to facilitate building, flashing and
simulating in Wokwi is also added.
### Build
- Terminal approach:

```
./build.sh [debug | release]
scripts/build.sh [debug | release]
```
> If no argument is passed, `release` will be used as default

Expand All @@ -48,7 +52,7 @@ simulating in Wokwi is also added.
- Using `flash.sh` script:

```
./flash.sh [debug | release]
scripts/flash.sh [debug | release]
```
> If no argument is passed, `release` will be used as default

Expand All @@ -71,7 +75,7 @@ used.
- Terminal approach:

```
./run-wokwi.sh [debug | release]
scripts/run-wokwi.sh [debug | release]
```
> If no argument is passed, `release` will be used as default

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.