Skip to content

Commit 83918e5

Browse files
committed
add README section
1 parent 14e9f80 commit 83918e5

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ OCPP 1.6 / 2.0.1 client for microcontrollers. Portable C/C++. Compatible with Es
1414

1515
Reference usage: [OpenEVSE](https://github.com/OpenEVSE/ESP32_WiFi_V4.x/blob/master/src/ocpp.cpp) | Technical introduction: [Docs](https://matth-x.github.io/MicroOcpp/intro-tech) | Website: [www.micro-ocpp.com](https://www.micro-ocpp.com)
1616

17+
## AI-friendly code
18+
19+
In 2025, the code base was largely restructured to work better with AI models. Chat bots can explain large parts of the code, write code snippets and help with the integration into the main charger firmware. Use your favorite AI tools with MicroOCPP and save hours of development time.
20+
21+
The best practices for AI-friendly code are not fully clear yet. The following was considered a good start:
22+
23+
- Consistency in architecture, variable names, algorithmic approaches
24+
- More granular functions to make complexities explicit on the caller end
25+
- Break down complexity and prefer duplicate code over deep abstraction
26+
- Strictly define resource ownership in comments
27+
28+
If your tools have issues working with something in MicroOCPP, please open an issue. Any ideas how to further optimize the code base are also highly appreciated.
29+
1730
## Tester / Demo App
1831

1932
*Main repository: [MicroOcppSimulator](https://github.com/matth-x/MicroOcppSimulator)*

0 commit comments

Comments
 (0)