Skip to content

15-doc-01: create readme - #82

Merged
sosias merged 3 commits into
mainfrom
15-doc-01-create-readme
Sep 24, 2026
Merged

sosias merged 3 commits into
mainfrom
15-doc-01-create-readme

Conversation

@sosias

@sosias sosias commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

Following subject requirements add documentation files

Fixes #7 #15 #16

Changes

  • add README
  • add Project managment files in docs/ and linked from the README
  • add graphs (game loop flow and main classes)

Testing

  • make lint passes locally
  • make test passes locally
  • Manually tested the behavior described above

Checklist

  • PR title follows <TICKET-ID>: short description
  • Linked to the correct issue (Fixes #... above)
  • No unrelated changes bundled into this diff
  • Updated README if this changes user-facing behavior (config keys, controls, etc.)

@sosias
sosias added this pull request to stack #81 September 20, 2026 23:49
@sosias sosias linked an issue Sep 20, 2026 that may be closed by this pull request
11 tasks
@sosias
sosias force-pushed the 15-doc-01-create-readme branch from aba1d8d to 4609f10 Compare September 24, 2026 15:56
Base automatically changed from 78-bug-04-fix-minor-bugs-make-hud-level-config to main September 24, 2026 15:57
@sosias
sosias force-pushed the 15-doc-01-create-readme branch from 4609f10 to 404d020 Compare September 24, 2026 15:57
@sosias
sosias merged commit 7f710f3 into main Sep 24, 2026
2 checks passed
@sosias
sosias deleted the 15-doc-01-create-readme branch September 24, 2026 18:12
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.

DOC-01: create README DOC-00: design documents (graphs)

2 participants