Skip to content

Add some basic documentation #5

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.

Sign up for GitHub

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

Open
ndrwng wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add some basic documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ You can also include images in this folder and reference them in the markdown. E

## How it works

Placeholder
Dino is a VGA-based side-scrolling runner where a dinosaur must dodge obstacles while a score accumulates. The game state (running, jumping, ducking, or game over) responds to a player controller with jump and duck inputs. Graphics are rendered using ROM-based sprites and synchronized by a VGA timing generator.

## How to test

Placeholder
Attach a VGA monitor via the VGA PMOD and connect button inputs to ui_in[0] for jump and ui_in[1] for duck. Reset the board to start the game and use the buttons to test gameplay.

## External hardware

Placeholder
A VGA monitor is required along with a player input controller.