Update README Page #193
Merged
Update README Page #193
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
ctrlvish
pushed a commit
to ctrlvish/splashkit-core
that referenced
this pull request
Dec 7, 2024
* Update README.md * remove extra folder/submodule --------- Co-authored-by: Olivia McKeon <[email protected]>
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.
Update README
Description
This pull request enhances the SplashKit Core README by providing a detailed overview of the repository, key features, and contributor guidelines. These updates make the README more informative, especially for new users and contributors exploring the core library of the SplashKit SDK.
Key Updates
New Introduction: Expanded the introduction to highlight SplashKit Core as the core library of the SplashKit SDK, which provides essential functions and tools for beginner-friendly game and application development. Emphasized its role in handling graphics, audio, input, networking, and more.
Features Section: Added a comprehensive list of features, including cross-platform compatibility, consolidated libraries, documentation and examples, and community-driven development. This gives potential users a clear understanding of what SplashKit Core offers.
Contributing Guidelines:
coresdkfor feature development,coresdk/src/testfor testing) to help contributors get started efficiently.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.