Update README
kisvegabor opened this issue · comments
I update the readme to make it more consistent and clear for users who are not so familiar with i18n yet.
Here it is: https://github.com/littlevgl/lv_i18n/blob/readme_kisvegabor/README.md
Still, there are some TODOs in it.
Ok. Let me know when done, i'll post comments
Only one section is missing so you can add the comments.
I've finished preliminary review. Let me know after update - i'll do the second pass.
PS. Please squash all into single commit after edit - it will be more easy find place to leave comments.
I'll update it soon.
Note about "intro". I don't know how to explain... goal is to make it short and more "recognizable". To help user think "yeah, i know what's that and wish to read details". Ideally, all should fit into 1 phrase. Max - 2 phrases. If user can't "switch on" immediately, it will not continue.
PS. Probably, my initial version was not perfect to. On review i don't keep in mind anything and read all with "clean brain". Don't accept any comment as personal critics.
I also don't think my version is better. It just was easier to follow for me.
I fixed some things: c8ae442
The introduction is not complete yet. IMO somehow the plural support should be highlighted be didn't find a way yet how to write it.
The introduction is not complete yet. IMO somehow the plural support should be highlighted be didn't find a way yet how to write it.
Novices will not understand how important is this. For experienced users this feature is essential. I think, is safe to skip this from intro.
Anyway, this package has no alternatives at all :)
Do you mean to emphasize more that it something really cool? :)
I pushed changes into separate branch instead of comments. Feel free to use of skip anything.
Your intro text look good! I will check in details soon
I formatted the C API section a little bit.
What is still missing:
- Follow modifications in the source code section. I didn't test it yet.
- Maybe improve the short description in the beginning.
Looks nice.
Probably mistyped: praslation => translation
Fixed, thank you!