Skip to content

Add Docker env build instructions #115

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.

Sign up for GitHub

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

Closed
rafaelcruzpb wants to merge 1 commit into from
Closed

Add Docker env build instructions #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions development/build-environment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,19 @@ We will be using Homebrew and nvm (Node Version Manager) to install the required
```

</TabItem>
<TabItem value="Docker" label="Docker" default>
This setup assumes an understanding of Docker usage.

1. Install [Docker](https://docs.docker.com/engine/install/) with `docker-compose`

2. Get GP2040-CE:

```bash
git clone https://github.com/OpenStickCommunity/GP2040-CE.git
cd GP2040-CE
git submodule update --init
```
</TabItem>
</Tabs>

## Building
Expand Down Expand Up @@ -324,5 +337,22 @@ Start in the GP2040-CE folder

4. Your UF2 file should be in the build directory.

</TabItem>
<TabItem value="Docker" label="Docker" default>

Start in the GP2040-CE folder

1. Start build:

- Without environment variables (using default values):
```bash
docker compose up --build
```
- With environment variables:
```bash
GP2040_BOARDCONFIG='Pico' PICO_BOARD='pico' docker compose up --build
```

2. Your UF2 file should be in the build directory.
</TabItem>
</Tabs>