XuanchenLin/NanUI

[REQUEST] English docs

CypherPotato opened this issue · 2 comments

I see a lot of potential in this project, it seems to be very cool. It would be interesting if there was an internationalized documentation to use this FW, in English for example.

Anyway, congrats! It's a really cool project. It's good to see that we have good alternatives to electron.

Sorry for my poor English, I tried to use Google Translate to translate the document in the previous version. Later, because of the iteration of the version, each version will have a lot of changes in usage, so I don't have much time to update and translate the project's documentation.

But don't worry, I have provided English comments in the code of the sample project, and you can quickly understand the usage and features of NanUI by following the sample code.

Recently, I am developing the code of a new version of the NanUI project, and use it as version 1.0 of this project. At that time, I will re-write the usage documentation according to the latest version and provide the English version of the documentation.

The documentation is now available in English. But I translated these documents from Chinese using Google Translate, so there are bound to be errors in the documents.

Feel free to submit PRs to improve the English documentation!