doc: update README #4994
Merged
doc: update README #4994
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdrueckert
added
Category: Doc
|
Seems fine :-) After @keturn brought it up I figure it may make more sense to just remove the build status rather than worry about fixing it. Little badges/shields were cool and neat a while ago for just being present, still kinda are, but more novelty than important. |
Cervator
previously approved these changes
Jan 31, 2022
skaldarnar
reviewed
Feb 2, 2022
README.md
Outdated
| ### Requirements | ||
|
|
||
| Technical Requirements: | ||
| - Java SE Development Kit (JDK) 11. It may be possible to use a later version of the JDK for local development, but the CI will verify against this baseline version. |
There was a problem hiding this comment.
I would either omit the latter part of "It may be possible to use a later version of the JDK [...]" as it is kind of an advanced topic you won't need for general setup, and it is definitely not recommended to start that way, or link to #3976 for further details.
We should probably keep "[T]he CI will verify against this baseline version."
There was a problem hiding this comment.
okay the way I changed it?
skaldarnar
approved these changes
Feb 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@keturn asked some of our (currently many) newcomers how they found us. Many of them mentioned that they found us via GitHub, so I thought it might be time to update and improve our README a bit.
The improvements include a bit more structure, more references to resources we typically manually hand out to people on Discord. I hope that we can improve the onboarding experience for new contributors and reduce the manual effort related to having to answer the same questions over and over. If our engine github repo indeed is the entrypoint, then hopefully this works better than the previous attempt of linking the adventure site on our website or pinning responses to frequently asked questions in discord channels.
How to review
Preview of the overhauled readme
To see the bigger changes in comparison to the old readme, look at the diff of the second commit.
The third commit changes the file extension so github doesn't recognize it as the same file anymore.
The commits afterwards are minor fixes and improvements that can be reviewed after having reviewed the bigger changes as mentioned above.
TODO before merging
OR