Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kisvegabor authored May 22, 2024
1 parent 4409236 commit d887323
Showing 1 changed file with 67 additions and 1 deletion.
68 changes: 67 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,67 @@
# board_template
# LVGL ported to BOARD NAME

## Overview

Short overview

## Buy

You can purchase ... from ...

## Benchmark

Describe the default buffering and other configuration.

YouTube video link

## Specification

### CPU and Memory
- **MCU:**
- **RAM:** ...MB internal, ...MB external SDRAM
- **Flash:** ...MB internal, ..MB External
- **GPU:** if any

### Display and Touch
- **Resolution:** ...x...
- **Display Size:** ..."
- **Interface:** SPI/LCD/MIPI/etc
- **Color Depth:** ...-bit
- **Technology:** TN/IPS
- **DPI:** ... px/inch
- **Touch Pad:** Resistive/Capacitive/None

### Connectivity
- Other peripheries

## Getting started

### Hardware setup
- jumpers, switches
- connect the display
- which USB port to use

### Software setup
- Install drivers if needed
- Install the IDE + links

### Run the project
- Clone this repository repository: ...
- Open the terminal or Import into an IDE...
- Build the project. How?
- Run or Debug. How?

### Debugging
- Debug `printf`?
- Other?
-
## Notes

Other notes, e.g. different configs, optimization opportunities, adding other libraries to the project, etc

## Contribution and Support

If you find any issues with the development board feel free to open an Issue in this repository. For LVGL related issues (features, bugs, etc) please use the main [lvgl repository](https://github.com/lvgl/lvgl).

If you found a bug and found a solution too please send a Pull request. If you are new to Pull requests refer to [Our Guide](https://docs.lvgl.io/master/CONTRIBUTING.html#pull-request) to learn the basics.

0 comments on commit d887323

Please sign in to comment.