Skip to content

Conversation

@breezy-codes
Copy link
Contributor

@breezy-codes breezy-codes commented Nov 3, 2024

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:

    • Added detailed, step-by-step guidance on installing SplashKit, cloning the repository, navigating to the game directory, and building the game.
    • Provided an optimised build command using -O3 for improved performance. (this was originally only at the end)
  • Detailed Controls Section:

    • Added an easy-to-follow layout of the controls for both Player 1 and Player 2, optimised for the Arcade Machine.
    • Included specific control actions, such as jump, crouch, and attack, mapped for each player, and clarified other controls like Pause and Selection.
  • New Game Features Section:

    • Highlighted unique gameplay aspects, such as multiplayer support, interactive environment, and combat mechanics.
    • Explained optimizations, including the use of the optimized build command and adjustments for resolution and controls.
  • New Contributing Section:

    • Encouraged community involvement and provided guidance on submitting pull requests or opening issues for feature suggestions or improvements.
  • 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.

@omckeon omckeon merged commit 5a23e99 into thoth-tech:main Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants