Getting started - ESP
First steps
The following sections describe the setup process for the ESP IoT Framework repository. For more information head over to:
Requirements
Make sure that python 3.8 or higher and pip3 are installed on your PC. Next ensure that you have installed a capable text editor like VS Code (any other editor should work fine as long a you can use the necessary plugins for this project).
Note
If your are using VS Code you can install some very helpful extensions. Those extension are optional but will simplify writing code. Check out the extensions tab further below.
Dependencies
The project requires some python packages which are essential f.e. for embedded development (PlatformIO) or for building docs (Mkdocs). You can install them by using pip3. Make sure that you are in the projects root folder
pip3 install -r requirements.txt
python3 -m pip install -r requirements.txt
After the installation you should be able to use mkdocs and pio, which are the CLI tools for the documentation and platformIO.
Hint
For more information about mkdocs head to Documentation
Extensions
This list contains some good extensions which make developing code way easier. As always, this is just a short summary of what's possible. If you want to dig deeper into Extensions and Tools for VS Code, visit their docs.