Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add standardized readme to all games #239

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

MHLoppy
Copy link
Contributor

@MHLoppy MHLoppy commented Oct 3, 2024

Description

Using Game readme template.md (in the advanced-game-design-team folder) as a template, every game in the repo now has a concise technical and gameplay overview, relevant links to documentation and other relevant known resources, and at least one screenshot.

This includes an opinionated judgement call on the quality of the existing code.

Build instructions have been intentionally omitted as this is simple shared knowledge between all SplashKit projects and is thus not project-specific knowledge - though it's not a big deal to add it in later either. edit: it was added

Type of change

  • Documentation (update or new)

How Has This Been Tested?

I've checked that the screenshot loads correctly for each readme and given them a once-over to catch most of the simple mistakes.

Testing Checklist

N/A

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • It's kind of too late to get anything reviewed because we did reorg and docs after everyone was finished with everything else but it's 6am and I feel like ticking the last box anyway

@MHLoppy
Copy link
Contributor Author

MHLoppy commented Oct 8, 2024

There was one point of common (negative) feedback from all SplashKit users that were asked for input: wanting a bit more hand-holding for the SplashKit side of things (how to build / use).

Balancing factors such as SplashKit's usage documentation being a bit poorly explained for first-time users, I've gone through and added some additional guidance at the top of each readme that should be enough to get new team members started.

@MHLoppy
Copy link
Contributor Author

MHLoppy commented Oct 27, 2024

One thing I didn't get around to is using automated tools to decide on code quality, which would ease the manual burden of maintaining that part of the docs (particularly since it's the most time-consuming part of it). I did take a quick look at some of the available tools but didn't find something that seemed like a great fit - maybe a future student can check it out!

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.

1 participant