Skip to content

Commit 45e67f2

Browse files
Update README Page (#193)
* Update README.md * remove extra folder/submodule --------- Co-authored-by: Olivia McKeon <ordmckeon@gmail.com>
1 parent 021c83f commit 45e67f2

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,56 @@
1-
# SplashKit
1+
# SplashKit Core Library
22

3-
[![Test SplashKit Core Linux Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20Linux/badge.svg)](https://github.com/splashkit/splashkit-core/actions) [![Test SplashKit Core macOS Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20macOS/badge.svg)](https://github.com/splashkit/splashkit-core/actions) [![Test SplashKit Core Windows Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20Windows/badge.svg)](https://github.com/splashkit/splashkit-core/actions)
3+
<img width="150px" align="right" src="https://github.com/thoth-tech/.github/blob/main/images/splashkit.png" alt="SplashKit Logo"/>
44

5-
SplashKit is a beginner's all-purpose software toolkit.
5+
**SplashKit Core** is the heart of the SplashKit SDK—a comprehensive library of functions and tools designed for beginner programmers to develop games and applications. SplashKit Core provides fundamental capabilities for handling graphics, input, audio, networking, and more, making it an ideal toolkit for introductory programming projects and game development.
66

7-
## Getting started
7+
[splashkit/splashkit-core](https://github.com/splashkit/splashkit-core)
88

9-
Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for details on getting started contributing to SplashKit.
9+
[![GitHub contributors](https://img.shields.io/github/contributors/splashkit/splashkit-core?label=Contributors&color=F5A623)](https://github.com/splashkit/splashkit-core/graphs/contributors)
10+
[![GitHub issues](https://img.shields.io/github/issues/splashkit/splashkit-core?label=Issues&color=F5A623)](https://github.com/splashkit/splashkit-core/issues)
11+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/splashkit/splashkit-core?label=Pull%20Requests&color=F5A623)](https://github.com/splashkit/splashkit-core/pulls)
12+
[![Forks](https://img.shields.io/github/forks/splashkit/splashkit-core?label=Forks&color=F5A623)](https://github.com/splashkit/splashkit-core/network/members)
13+
[![Stars](https://img.shields.io/github/stars/splashkit/splashkit-core?label=Stars&color=F5A623)](https://github.com/splashkit/splashkit-core/stargazers)
14+
15+
[thoth-tech/splashkit-core](https://github.com/thoth-tech/splashkit-core)
16+
17+
[![GitHub contributors](https://img.shields.io/github/contributors/thoth-tech/splashkit-core?label=Contributors&color=F5A623)](https://github.com/thoth-tech/splashkit-core/graphs/contributors)
18+
[![GitHub issues](https://img.shields.io/github/issues/thoth-tech/splashkit-core?label=Issues&color=F5A623)](https://github.com/thoth-tech/splashkit-core/issues)
19+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/thoth-tech/splashkit-core?label=Pull%20Requests&color=F5A623)](https://github.com/thoth-tech/splashkit-core/pulls)
20+
[![Forks](https://img.shields.io/github/forks/thoth-tech/splashkit-core?label=Forks&color=F5A623)](https://github.com/thoth-tech/splashkit-core/network/members)
21+
[![Stars](https://img.shields.io/github/stars/thoth-tech/splashkit-core?label=Stars&color=F5A623)](https://github.com/thoth-tech/splashkit-core/stargazers)
22+
23+
**\* SplashKit Development in Thoth Tech**
24+
25+
Thoth Tech is a people-focused educational technology company within Deakin University's capstone program which provides real-world learning opportunities and allows students to contribute significantly to projects like SplashKit, enhancing its capabilities and resources.
26+
27+
### Current Build Status
28+
29+
[![Test SplashKit Core Linux Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20Linux/badge.svg)](https://github.com/splashkit/splashkit-core/actions)
30+
[![Test SplashKit Core macOS Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20macOS/badge.svg)](https://github.com/splashkit/splashkit-core/actions)
31+
[![Test SplashKit Core Windows Actions Status](https://github.com/splashkit/splashkit-core/workflows/SplashKit%20Core%20Windows/badge.svg)](https://github.com/splashkit/splashkit-core/actions)
32+
33+
## Features
34+
35+
- **Cross-Platform Compatibility**: SplashKit Core supports Windows, macOS, and Linux, ensuring your applications can run seamlessly across different environments.
36+
- **All-in-One Library**: SplashKit consolidates graphics, audio, input handling, networking, and more, offering an easy-to-use API that is accessible for beginners.
37+
- **Extensive Documentation and Examples**: Each function is well-documented, with usage examples available for various languages supported by SplashKit.
38+
- **Community-Driven Development**: Contributors are encouraged to add new features, fix bugs, and improve the core library, enhancing the experience for all users.
39+
40+
## Contributing to SplashKit
41+
42+
SplashKit Core is an open-source project, and we welcome contributions from developers of all skill levels. Here’s how you can contribute:
43+
44+
1. **Feature Development**:
45+
- Add new features or improve existing functionality within the `coresdk` directory.
46+
47+
2. **Testing**:
48+
- Add test cases in `coresdk/src/test` to verify new functionality or improvements.
49+
50+
3. **Documentation**:
51+
- Ensure that any new functions are documented clearly to help users understand their purpose and usage.
52+
53+
4. **Pull Requests**:
54+
- Once you’ve made your changes, submit a pull request with a description of your work. Make sure all tests pass before submitting.
55+
56+
**Note**: Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for platform-specific prerequisites and setup details.

0 commit comments

Comments
 (0)