Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2025-12-13 08:20:13 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity

alif/README: Update README with build instructions.

Browse Source 
Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
This commit is contained in:
iabdalkader
2025-06-10 10:46:09 +02:00
committed by Damien George
parent 8cd8e146a4
commit 9b38cf9f82
1 changed files with 58 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
ports/alif/README.md
View File

@@ -19,3 +19,61 @@ The following more advanced features will follow later:
- Ethernet support.
- SDRAM support.
- Other machine modules.
Build instructions
------------------
Before building the firmware for a given board the MicroPython cross-compiler
must be built; it will be used to pre-compile some of the built-in scripts to
bytecode. The cross-compiler is built and run on the host machine, using:
```bash
$ make -C mpy-cross
```
This command should be executed from the root directory of this repository.
All other commands below should be executed from the ports/alif/ directory.
An ARM compiler is required for the build, along with the associated binary
utilities. The recommended toolchain version to use with this port is
Arm GNU toolchain version 13.3.Rel1. The compiler can be changed using the
`CROSS_COMPILE` variable when invoking `make`.
Next, the board to build must be selected. The default board is `ALIF_ENSEMBLE`
but any of the names of the subdirectories in the `boards/` directory is valid.
The board name must be passed as the argument to `BOARD=` when invoking `make`.
All boards require certain submodules to be obtained before they can be built.
The correct set of submodules can be initialised using (with `ALIF_ENSEMBLE`
as an example of the selected board):
```bash
make BOARD=ALIF_ENSEMBLE submodules
```
Then to build the board's firmware run:
```bash
make BOARD=ALIF_ENSEMBLE
```
The above command should produce binary images in the `build-ALIF_ENSEMBLE/`
subdirectory (or the equivalent directory for the board specified).
### Update the SE Firmware
The SE firmware must be updated **before** flashing the main firmware to match
the version used by MicroPython. This step only needs to be performed once.
Connect the board to your PC via the **SE UART USB** port (on the Ensemble kit,
this is labeled **PRG USB**), then run:
```bash
make update-system-package
```
**Note:** The board must be power-cycled after this step.
### Deploy MicroPython
To flash the firmware, run:
```bash
make BOARD=ALIF_ENSEMBLE deploy
```