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.

Sign up for GitHub

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

Jump to bottom

Update README.md #1556

Merged
merged 1 commit into from
Jan 31, 2023
Merged

Update README.md #1556

merged 1 commit into from
Jan 31, 2023

Conversation

mrfloris
Copy link
Contributor

  • Since there's no jenkins or releases it will always show red in the top icons, I've removed the two
  • Moved the issues and pulls icons to the same line as the first two
  • Moved the header with the image to the top
  • Re-wrote the introduction text to be more friendly, yet informative. And proofread it for grammar/spelling. This way it's a bit more modern and current.
  • Made sure the headers # vs ## are a bit better (consistency)
  • Made sure there was a clear mention near the top of the required cmilib library
  • Made the introduction more friendly to the releases links, and include cmilib there, as well a mention that tech savvy people can get the code and compile it,
  • Included a bit more clear listing for officially supported (and not..) server engines. People who confirm this works on their modded server are free to clone/pr their findings I guess
  • Included installation instructions for people who don't want to deal with code, or are new to server running, they now can find the download links, the required library file, and the extra server restart text .. all in one readme document. hopefully lowering the 'it does not work' questions on discord etc.
  • Bugs and suggestions - this is added to explain where to post what, and that if they know how to fix the bug that they can clone/pr it.
  • Moved support before API, and moved API as a whole lower on the page.
  • Made sure discord community is part of support
  • Included link to the official zrips.net website for the jobs/api uner API
  • And I've moved the credits to the bottom, as most ppl who come to github come to find out what this is about, how to get it, how to get support .. so credits can be a bit lower. And I've included a link to the contributions made by others. I hope it's the correct way of doing that.
  • General grammar/spelling reviewed.
  • Made the document a bit more 'the same as' to match the more recent cmilib readme update. (more indirect-consistency)
  • Included basic permissions examples, because I noticed on discord people keep asking a few times per week.

@mrfloris
Update README.md
43b7051 
- Since there's no jenkins or releases it will always show red in the top icons, I've removed the two
- Moved the issues and pulls icons to the same line as the first two
- Moved the header with the image to the top
- Re-wrote the introduction text to be more friendly, yet informative. And proofread it for grammar/spelling. This way it's a bit more modern and current.
- Made sure the headers `#` vs `##` are a bit better (consistency)
- Made sure there was a clear mention near the top of the required cmilib library
- Made the introduction more friendly to the releases links, and include cmilib there, as well a mention that tech savvy people can get the code and compile it, 
- Included a bit more clear listing for officially supported (and not..) server engines. People who confirm this works on their modded server are free to clone/pr their findings I guess
- Included installation instructions for people who don't want to deal with code, or are new to server running, they now can find the download links, the required library file, and the extra server restart text .. all in one readme document. hopefully lowering the 'it does not work' questions on discord etc.
- Bugs and suggestions - this is added to explain where to post what, and that if they know how to fix the bug that they can clone/pr it.
- Moved support before API, and moved API as a whole lower on the page.
- Made sure discord community is part of support
- Included link to the official zrips.net website for the jobs/api uner API
- And I've moved the credits to the bottom, as most ppl who come to github come to find out what this is about, how to get it, how to get support .. so credits can be a bit lower. And I've included a link to the contributions made by others. I hope it's the correct way of doing that. 
- General grammar/spelling reviewed.
- Made the document a bit more 'the same as' to match the more recent cmilib readme update. (more indirect-consistency) 
- Included basic permissions examples, because I noticed on discord people keep asking a few times per week.
@Zrips Zrips merged commit a4f6f06 into Zrips:master Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mrfloris @Zrips