lc-soft / LCUI

C library for building user interfaces
https://lcui-dev.github.io
MIT License
4.12k stars 356 forks source link

English API Documentation #259

Open MichealShinoda opened 2 years ago

MichealShinoda commented 2 years ago

Is your feature request related to a problem? Please describe. No, I just got familiar with LCUI and it seems it can be one of the best ui engines in future. Demo was very good but as a programmer I find it very hard to learn, there's no documentation that explains how it works and it's very time consuming to read entire source code to see how it works.

Describe the solution you'd like I would like to have a good and complete documentation of how it works and how to implement stuff, how to connect things together and how to implement custom controls.

Additional context A good example can be Ultralight : https://docs.ultralig.ht/docs/

lc-soft commented 2 years ago

You can use the browser's translation tool to translate this Chinese document: http://docs.lcui.lc-soft.io/

I plan to translate it into English when it has enough content. In order to make the document better, you can tell me what you need to know so that I can consider adding relevant content to the document.

MichealShinoda commented 2 years ago

Translated version is good enough for now! I start working with the library and I post if I face anything I feel is needed here. Thank you for your time and effort on this project, It's promising. ❤️

MichealShinoda commented 2 years ago

@lc-soft I saved all the pages and translated them to english with auto translator it toke some time but it's useful and can be used for a temporary time. Here it is I hope it be helpful or others: lcui-docs-english-auto-translated.zip (7zip)