MirrorSave
/
ESPresense
mirror of https://github.com/ESPresense/ESPresense.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Create BUILDING.md

This commit is contained in:
Darrell 2021-10-09 10:14:39 -04:00 committed by DTTerastar
parent 6fa843599d
commit e8dbf498e8
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
BUILDING.md Normal file
View File

@ -0,0 +1,5 @@
This project uses [PlatformIO](https://platformio.org/) to simplify development. The easiest way to get started is to install [VSCode](https://code.visualstudio.com/) and the [PlatformIO VSCode plugin](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide) (simple instructions [here](https://platformio.org/install/ide?install=vscode)).
Once you have opened this project, building and uploading the project to your ESP32 board is as easy as clicking on the Build and Upload buttons.
![PlatformIO Build/Upload Buttons](https://docs.platformio.org/en/latest/_images/platformio-ide-vscode-build-project.png)

2
README.md
View File

@ -6,4 +6,6 @@ An ESP32 based presence detection node for use with the [Home Assistant](https:/
**Documentation:** https://espresense.com/
**Building:** [building](./BUILDING.md).
**Release Notes:** [changelog](./CHANGELOG.md).