AfRApay/AfRApay.MateCard/README.md

11 lines
717 B
Markdown
Raw Normal View History

2023-02-08 16:23:49 +01:00
# 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:
2023-02-16 19:25:02 +01:00
- 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))
2023-02-08 16:23:49 +01:00
- To compile, run `pio run`
- To compile and upload, run `pio run -t upload`
- To run clang-tidy, run `pio check`.
- Please run `uncrustify --no-backup -c .uncrustify.cfg src/*.cpp include/*.h` before commiting. To install it as a pre-commit hook, run `ln -s ../../hooks/pre-commit.hook ../.git/hooks/pre-commit` in this directory.