Update to README for T3 2024 #3
Merged
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.
Update README
Description
This PR updates the Below The Surface README with a comprehensive overview, installation instructions, optimized controls for the Arcade Machine, and a new Contributing section. These enhancements aim to provide clear guidance for both players and contributors, making the setup process easier and the purpose of each feature more accessible.
Key Updates
Expanded Overview Section: Introduced an engaging description of the game’s theme and objectives, highlighting the action-adventure aspects and multiplayer compatibility.
Enhanced Installation Instructions:
-O3for improved performance. (this was originally only at the end)Detailed Controls Section:
New Game Features Section:
New Contributing Section:
GitHub Stats: Added badges for GitHub contributors, issues, pull requests, forks, and stars for both SplashKit and Thoth Tech repositories. These stats offer an at-a-glance view of project activity and community engagement.
Motivation
The goal of these changes is to make the README more comprehensive and user-friendly, especially for new contributors and users in preparation for Trimester 3 2024.