diff --git a/README.md b/README.md index 455eb90..15569dd 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,14 @@ -# _Sample project_ +# _ESP32 S2 Cal Demo_ -(See the README.md file in the upper level 'examples' directory for more information about examples.) +This is a demo project for a certain ESP32-S2 board. -This is the simplest buildable example. The example is used by command `idf.py create-project` -that copies the project to user specified path and set it's name. For more information follow the [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project) +## How to create 4-indexed(2bit) image files +Use imagemagick and `bin2c` utility from CUDA toolchain +```bash +# Create an indexed image from any input file +magick 57852730_p0_4indexed.png -depth 2 57852730_p0_4indexed.gray - -## How to use example -We encourage the users to use the example as a template for the new projects. -A recommended way is to follow the instructions on a [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project). - -## Example folder contents - -The project **sample_project** contains one source file in C language [main.c](main/main.c). The file is located in folder [main](main). - -ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` -files that provide set of directives and instructions describing the project's source files and targets -(executable, library, or both). - -Below is short explanation of remaining files in the project folder. - -``` -├── CMakeLists.txt -├── main -│   ├── CMakeLists.txt -│   └── main.c -└── README.md This is the file you are currently reading -``` -Additionally, the sample project contains Makefile and component.mk files, used for the legacy Make based build system. -They are not used or needed when building with CMake and idf.py. +# Convert the image to C array +bin2c 57852730_p0_4indexed.gray > 57852730_p0_4indexed.c +``` \ No newline at end of file