11 lines
677 B
Markdown
11 lines
677 B
Markdown
# AfRApay.MateCard
|
|
This is the software that runs on the MateCard terminal, powered by an ESP32.
|
|
|
|
## Setting up dev environment
|
|
This project uses PlatformIO. Quick setup guide:
|
|
- Install PlatformIO (macOS: `brew bundle` in project root OR `brew install platformio uncrustify` / Arch Linux: `yay -S platformio uncrustify` / Other: [platformio.org](https://platformio.org/install/cli))
|
|
- To compile, run `pio run`
|
|
- To compile and upload, run `pio run -t upload`
|
|
- To run clang-tidy, run `pio check`.
|
|
- Please run `./scripts/uncrustify.sh` before commiting. To install it as a pre-commit hook, run `ln -s ../../hooks/pre-commit.hook ../.git/hooks/pre-commit` in this directory.
|