Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
markzakharyan authored Oct 1, 2024
1 parent a3abbb7 commit 7d524a4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@ The firmware is designed to be easily extensible, as new peripherals can simply

**If you have any questions**, feel free to email (or slack) [[email protected]](mailto:[email protected])

<!--
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
-->

## Installation

This firmware is comprised of two individual PlatformIO projects, one for the M7 core and the other for the M4. To build and upload to the Arduino Giga, you need to install PlatformIO and separately upload the firmware for **both** the M7 and M4 processors (found in their respective folders). There is no extra configuration you need to do, as all processor information is contained in each project's platformio.ini file.

## Usage

Since PlatformIO does not yet have support for the Arduino Giga, we have forked a custom implementation of PlatformIO for the Giga found at [https://github.com/afylab/platform-ststm32#develop](https://github.com/afylab/platform-ststm32#develop). This is what each project uses to build for the Giga, and is found in each project's platformio.ini.
Since PlatformIO does not yet have support for the Arduino Giga, we have forked a custom implementation of PlatformIO for the Giga found [here](https://github.com/afylab/platform-ststm32#develop). This is what each project uses to build for the Giga, and is found in each project's platformio.ini.

A full guide on the code structure is being developed and can currently be found [here](https://share.note.sx/n340o95a#1ld68Rexy9NMUivdsulvSYpptsx1KMYcsj4a4mlvtj4). The location of these docs may change in the future, but a link to the newest docs will always be on this GitHub repository.

Expand Down

0 comments on commit 7d524a4

Please sign in to comment.