Skip to content

Commit 9c19fc7

Browse files
committed
readme: update
1 parent f6bbffe commit 9c19fc7

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ advertise the camera's IP address / port that the RTSP server is running on.
1616
- [Use](#use)
1717
- [Program](#program)
1818
- [Configure](#configure)
19+
- [Development](#development)
20+
- [Environment](#environment)
21+
- [Build and Flash](#build-and-flash)
1922
- [Hardware](#hardware)
2023
- [Full pin-out:](#full-pin-out)
2124
- [Camera Interface (OV3660):](#camera-interface-ov3660)
@@ -96,6 +99,34 @@ Commands available:
9699
Display the current battery voltage.
97100
```
98101

102+
## Development
103+
104+
If you wish to modify / recompile the code, you will need to set up your
105+
development environment to be able to build and flash your target hardware.
106+
107+
### Environment
108+
109+
This project is an ESP-IDF project, currently [ESP-IDF
110+
v.5.4](https://github.com/espressif/esp-idf).
111+
112+
For information about setting up `ESP-IDF v5.4`, please see [the official
113+
ESP-IDF getting started
114+
documentation](https://docs.espressif.com/projects/esp-idf/en/v5.4/esp32s3/get-started/index.html).
115+
116+
### Build and Flash
117+
118+
Build the project and flash it to the board, then run monitor tool to view serial output:
119+
120+
```
121+
idf.py -p PORT flash monitor
122+
```
123+
124+
(Replace PORT with the name of the serial port to use.)
125+
126+
(To exit the serial monitor, type ``Ctrl-]``.)
127+
128+
See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
129+
99130
## Hardware
100131

101132
This sample is designed to run on the ESP32 TimerCam ([Amazon Link](https://www.amazon.com/dp/B09W2RSPGL?psc=1&ref=ppx_yo2ov_dt_b_product_details)).

0 commit comments

Comments
 (0)