Skip to content

Commit 0262c9b

Browse files
committed
docs: prepare README for publication
Signed-off-by: Ozan Durgut <ozndrgt@gmail.com>
1 parent 3fd6857 commit 0262c9b

1 file changed

Lines changed: 40 additions & 10 deletions

File tree

README.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,51 @@
11
# embedDIP
22

3-
**embedDIP** is a portable, embedded digital image processing library written in C/C++ for use on microcontrollers. It provides foundational and advanced image processing functionality with support for various peripherals.
3+
Source repository: https://github.com/embeddip/embedDIP
44

5-
---
5+
embedDIP is a portable digital image processing library for embedded systems. It is written in C and C++ and is intended for microcontroller projects that need image data structures, image processing routines, and board-specific peripheral support.
66

7-
## License
7+
The library is used by the example projects for the book *Embedded Digital Image Processing with Microcontrollers*.
88

9-
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
9+
## Contents
1010

11-
---
11+
- `core/`: core image, error, and memory management interfaces.
12+
- `imgproc/`: image processing modules, including filtering, thresholding, morphology, color conversion, histograms, segmentation, drawing, compression, and FFT support.
13+
- `device/`: common camera, display, and serial interfaces.
14+
- `board/`: board profiles for supported targets.
15+
- `arch/`: architecture-specific implementations.
16+
- `wrapper/`: C++ wrapper classes.
17+
- `docs/`: documentation configuration and support files.
1218

13-
## Author
19+
## Build
20+
21+
embedDIP is built with CMake. Select the target board, architecture, and CPU through CMake cache variables.
22+
23+
Example for STM32F7:
24+
25+
```bash
26+
cmake -S . -B build -DEMBEDDIP_TARGET_BOARD=STM32F7 -DEMBEDDIP_ARCH=ARM -DEMBEDDIP_CPU=CORTEX_M7
27+
cmake --build build
28+
```
29+
30+
Example for ESP32:
1431

15-
Developed and maintained by [Ozan Durgut](https://github.com/ozan956) for embedded systems and digital image processing research.
32+
```bash
33+
cmake -S . -B build -DEMBEDDIP_TARGET_BOARD=ESP32 -DEMBEDDIP_ARCH=XTENSA -DEMBEDDIP_CPU=LX6
34+
cmake --build build
35+
```
1636

17-
Feel free to fork, contribute, or suggest enhancements via [issues](https://github.com/EmbedDIP/embedDIP/issues).
37+
The library can also be included from another CMake project with `add_subdirectory(embedDIP)`.
1838

19-
---
39+
## Related Repositories
40+
41+
- ESP32 examples: https://github.com/embeddip/examples-esp32
42+
- STM32 examples: https://github.com/embeddip/examples-stm32
43+
- Python UART transfer tool: https://github.com/embeddip/PyDIPLink
44+
45+
## License
46+
47+
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
48+
49+
## Author
2050

21-
> © 2023–2026 [EmbedDIP](https://github.com/EmbedDIP).
51+
Developed by Ozan Durgut for embedded systems and digital image processing examples.

0 commit comments

Comments
 (0)