Skip to content

Commit

Permalink
Add building steps for Pinecil V2 to Development.md (#1634)
Browse files Browse the repository at this point in the history
  • Loading branch information
ew1abz authored Mar 24, 2023
1 parent 11bad84 commit 6177d4e
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions Documentation/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,40 @@ If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.p
Follow the same idea as the STM Cube IDE notes above.

## Building Pinecil V2

To build the Pinecil V2 firmware, you can use a Docker container that provides a consistent development environment across different operating systems, including Windows with WSL2. Here's how to do it:

### Prerequisites

Docker Desktop: Install the latest version of Docker Desktop for your operating system from the official website.

On Windows follow the instructions on the official documentation to install 'Windows Subsystem for Linux' (WSL2).

### Building Steps

1. Clone the repository, initialize and update submodules:

```sh
git clone --recurse-submodules https://github.com/Ralim/IronOS.git
```

2. Start the Docker container with the development environment:

```sh
cd IronOS
./start_dev.sh
```

This script will build a Docker image and run a container with the necessary tools to build the firmware.

3. Build the firmware for Pinecil V2:

```sh
cd source/source
./build.sh -l EN -m Pinecilv2
```

This command will compile the firmware with English language support for Pinecil V2 board.

4. Find the firmware artifacts:
After the build completes successfully, you can find the firmware artifacts in the `source/Hexfile` directory.

0 comments on commit 6177d4e

Please sign in to comment.