search

lvgl / lv_i18n

Internationalization (i18n) for LVGL
MIT License
58 stars 17 forks source link

Update README #15

Closed kisvegabor closed 5 years ago

kisvegabor commented 5 years ago

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.

puzrin commented 5 years ago

Ok. Let me know when done, i'll post comments

kisvegabor commented 5 years ago

Only one section is missing so you can add the comments.

puzrin commented 5 years ago

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.

kisvegabor commented 5 years ago

I'll update it soon.

puzrin commented 5 years ago

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.

kisvegabor commented 5 years ago

I also don't think my version is better. It just was easier to follow for me.

kisvegabor commented 5 years ago

I fixed some things: https://github.com/littlevgl/lv_i18n/commit/c8ae442e219e996c55a947b5dfade2bff46ba8f9

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.

puzrin commented 5 years ago

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 :)

kisvegabor commented 5 years ago

Do you mean to emphasize more that it something really cool? :)

puzrin commented 5 years ago

https://github.com/littlevgl/lv_i18n/commit/5cca0bef0137d95e3835ef378d274bdfa1b79af3

I pushed changes into separate branch instead of comments. Feel free to use of skip anything.

kisvegabor commented 5 years ago

Your intro text look good! I will check in details soon

kisvegabor commented 5 years ago

I formatted the C API section a little bit.

What is still missing:

puzrin commented 5 years ago

Looks nice.

Probably mistyped: praslation => translation

kisvegabor commented 5 years ago

Fixed, thank you!