OpenHands icon indicating copy to clipboard operation
OpenHands copied to clipboard

[doc] add README-zh.md

Open mahone3297 opened this issue 1 year ago • 8 comments

mahone3297 avatar Apr 15 '24 09:04 mahone3297

Note: Need to update with main.

Umpire2018 avatar Apr 15 '24 13:04 Umpire2018

@Umpire2018 I have updated with the main branch, pls review.

mahone3297 avatar Apr 16 '24 02:04 mahone3297

LGTM.

Umpire2018 avatar Apr 16 '24 02:04 Umpire2018

This looks good but I have a concern about maintenance. Whenever we update the English README, we would have to update the Chinese README to match. This can be an issue if maintainers don't know Chinese.

yimothysu avatar Apr 16 '24 13:04 yimothysu

I share @yimothysu's concern--I was hoping to take another pass at the README soon.

Maybe we should put a warning at the top saying something like

WARNING: This README may be out of date. README.md should be considered the source of truth. If you notice differences, please open a pull request to update this README

We should also probably put it in a subdirectory, so that the root directory doesn't get clogged with different languages

rbren avatar Apr 16 '24 15:04 rbren

If you are ok with it, I can put it into the docs folder.

mahone3297 avatar Apr 17 '24 00:04 mahone3297

@mahone3297 docs folder sgtm!

rbren avatar Apr 17 '24 16:04 rbren

I have put the README-zh.md into the docs folder and put a warning at the top of the file.

mahone3297 avatar Apr 18 '24 01:04 mahone3297

Thank you!

rbren avatar Apr 18 '24 10:04 rbren