Updated README.md #1
Open
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
Added additional information and features to the README. md
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.
Added additional information and features to the README. md.
Detailed Description (What could be improved and what was improved):
Overall, I have made the README.md file to be much more intuitive and easy to read for anyone popping in. I added proper step by step instructions for installation with Windows, Linux, and Raspberry Pi. Included all the necessary dependencies and system requirements to minimize installation issues. Created a dedicated section explaining how to configure Arctic Engine. Previously there was no detailed information on each configuration option and there were no practical examples that users could look through. For the code of conduct, I included a briefer version of the code of conduct in the README so that contributors and users are immediately aware of the expected behavior in the community. Additionally, I added a section on performance optimization going over asset loading and rendering, which can help users begin easier with the project. Also added a table of contents so it would be easier for users to track the topics that are mentioned in the README.