AfRA/AfRApay
3
0
Fork 0
Code Issues 7 Pull requests Packages Projects Releases Wiki Activity

Add c++ contribution guide

Browse source
This commit is contained in:
Laura Hausmann 2023-02-08 16:23:49 +01:00
parent 83f9b57b56
commit da8572d76f
Signed by: zotan
GPG key ID: D044E84C5BE01605
3 changed files with 3606 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3593
AfRApay.MateCard/.uncrustify.cfg Normal file
View file

File diff suppressed because it is too large Load diff

10
AfRApay.MateCard/README.md Normal file
View file

@ -0,0 +1,10 @@
# 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 install platformio` / Arch Linux: `yay -S platformio` / 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 `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.

3
hooks/pre-commit.hook Executable file
View file

@ -0,0 +1,3 @@
#!/bin/bash
cd AfRApay.MateCard
uncrustify --no-backup -c .uncrustify.cfg src/*.cpp include/*.h