diff options
author | Vladimir <[email protected]> | 2023-03-24 06:19:52 -0700 |
---|---|---|
committer | GitHub <[email protected]> | 2023-03-24 13:19:52 +0000 |
commit | 6177d4e2a4736992c651847556f2dc97a1ae59cb (patch) | |
tree | 736bc07cf2977c5fc9e39505427bcf9820b2cfd4 /Documentation | |
parent | 11bad84ce7a44c9d2ef0141459a2dc175e5b671a (diff) | |
download | IronOS-6177d4e2a4736992c651847556f2dc97a1ae59cb.tar.gz IronOS-6177d4e2a4736992c651847556f2dc97a1ae59cb.zip |
Add building steps for Pinecil V2 to Development.md (#1634)
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/Development.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/Development.md b/Documentation/Development.md index 79497af5..b43ae2d1 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -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. |