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

Update README.md - format and grammar #2

Conversation

Supamang2122
Copy link

Hi,

I am a Computer Science Student based in Vancouver, Canada! I have a project that requires me to edit documentation on random github repositories. I came across yours and it seemed really interesting! I've listed some changes below to the README file, that I think will make the document easier to understand. Note: There are no changes to the code, just the documentation! I hope these changes benefit your project!

All the best,

Supamang

Change Notes:

  • Changed "By" to "Creator: "
  • Added space between "website" and website link, "Server" and "Download", "Client" and "Download"
  • Changed "At present, balanced binary tree is used in data structure, and its unique data storage structure makes it still competent in the face of a large amount of data" to "This is a database system, completely based on java! The data structure used is a balanced binary tree. This data structure allows for efficient storage, insertion and deletion even with large amounts of data."
  • Added bullet points to separate each feature in Brief Introduction Section
  • Changed "Of course, you should do it after stop this application" to "Warning: Only change config after shutting down application."

- Changed "By" to "Creator: "
- Added space between "website" and website link, "Server" and "Download", "Client" and "Download"
- Changed "At present, balanced binary tree is used in data structure, and its unique data storage structure makes it still competent in the face of a large amount of data" to "This is a database system, completely based on java! The data structure used is a balanced binary tree. This data structure allows for efficient storage, insertion and deletion even with large amounts of data."
- Added bullet points to separate each feature in Brief Introduction Section
- Changed "Of course, you should do it after stop this application" to "Warning: Only change config after shutting down application."
@BestLoveForYou
Copy link
Owner

Thanks a million, your suggestion has been adopted in the latest version

@BestLoveForYou BestLoveForYou deleted the branch BestLoveForYou:v1.000.20220711 August 13, 2022 10:05
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