Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] English Grammar Revision #25

Merged
merged 2 commits into from
Oct 13, 2018

Conversation

Still34
Copy link
Contributor

@Still34 Still34 commented Oct 13, 2018

Summary

This PR is a work-in-progress. This PR fixes various English grammar and spelling mistakes found in documentation and or general files such as README.md.

@Still34
Copy link
Contributor Author

Still34 commented Oct 13, 2018

The current ./README.md refers to example/README.md for more detailed CLI instructions; however, in line 19 of the same file, it refers to example/README.md for Chinese instructions. This creates a conflict and can confuse English users.

To keep in line with the overall language, example/README.md should be translated into English while the original CHT text should be kept in a separate file (e.g. README.zh-TW.md). This is open for discussion.

@kevinbird61
Copy link
Member

kevinbird61 commented Oct 13, 2018

Big thanks! LGTM

@kevinbird61 kevinbird61 merged commit 06ff7db into toolbuddy:master Oct 13, 2018
@Still34
Copy link
Contributor Author

Still34 commented Oct 13, 2018

This was meant to be a work-in-progress with extended discussion, but guess we could open a separate issue for that. 🤔

@kevinbird61
Copy link
Member

Oh, in deed, currently README.md was a mess.
It need an effort to separate them into different file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants