Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ ARG DEBIAN_FRONTEND=nointeractive
RUN apt-get update \
&& apt install -y -q \
cmake \
default-jre \
git \
hwdata \
libglib2.0-dev \
Expand Down
9 changes: 7 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ git checkout <the branch you want>
# This will take several minutes to finish
docker build -t espminer-build .devcontainer
```

### Building

```
Expand All @@ -156,15 +157,19 @@ docker run --rm -it -v $PWD:/workspace espminer-build /bin/bash
git config --global --add safe.directory /workspace # set git permissions or build will fail; only done once
cd /workspace
idf.py build
```
```

Once the build is done exit out of the docker session and flash the new firmware.

## Development
## Development (local build, without Docker)

If you prefer to build on your machine without using the devcontainer, install the prerequisites below.

### Prerequisites

- Install the ESP-IDF toolchain from https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/
- Install nodejs/npm from https://nodejs.org/en/download
- Install a Java Runtime (e.g. OpenJDK JRE)
- (Optional) Install the ESP-IDF extension for VSCode from https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension

### Building
Expand Down