mirror of
https://github.com/BotChain-Robots/firmware.git
synced 2026-07-08 17:47:21 +02:00
Update README.md
This commit is contained in:
13
README.md
13
README.md
@@ -2,8 +2,8 @@
|
||||
|
||||
**This project is currently setup to work with the ESP32, we will be using the ESP32-c6 in the future.**
|
||||
|
||||
## Install Dependencies
|
||||
### MacOS
|
||||
### Install Dependencies
|
||||
#### MacOS
|
||||
Install xcode command line tools (if you do not already have them)
|
||||
```
|
||||
xcode-select --install
|
||||
@@ -24,10 +24,11 @@ cd ~/esp/isp-idf
|
||||
./install.sh esp32
|
||||
```
|
||||
|
||||
## Running
|
||||
## Development
|
||||
### Command Line Tools
|
||||
The board is flashed via UART. A USB to UART adapter is provided as part of the devboard.
|
||||
|
||||
### MacOS
|
||||
#### MacOS
|
||||
Export environment variables
|
||||
```
|
||||
. ~/esp/esp-idf/export.sh
|
||||
@@ -43,9 +44,9 @@ Flash and open serial monitor
|
||||
idf.py flash monitor
|
||||
```
|
||||
|
||||
## Using an IDE
|
||||
### Using an IDE
|
||||
Any IDE that supports CMake should be compatible with this project.
|
||||
### JetBrains CLion
|
||||
#### JetBrains CLion
|
||||
CLion is compatible with this project. Follow [the tutorial on Espressif's site](https://developer.espressif.com/blog/clion/) with the following modifications:
|
||||
- When asked to select a project, simply import the root directory of this repository (ie. the `firmware` folder).
|
||||
- If the `Open Project Wizard` does not open, access it via `Settings > Build, Execution, Deployment > CMake`.
|
||||
|
||||
Reference in New Issue
Block a user