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 Project README #1

Open
2 of 4 tasks
lewxdev opened this issue Jan 8, 2023 · 2 comments
Open
2 of 4 tasks

Add Project README #1

lewxdev opened this issue Jan 8, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lewxdev
Copy link
Owner

lewxdev commented Jan 8, 2023

README should include details about:

  • what the project is (what Tower of Hanoi is and how to play)
  • some brief details about the Kenzie assignment and rubric, contributors, etc.
  • development details and technologies used
  • usage details, keyboard shortcuts, etc.
@lewxdev lewxdev added the documentation Improvements or additions to documentation label Jan 8, 2023
@lewxdev lewxdev self-assigned this Jan 8, 2023
@lewxdev
Copy link
Owner Author

lewxdev commented Jan 30, 2023

Rubric (via Canvas)

  1. Worked with a teammate and submitted teammate name in submission comment [1.0 / 1.0 pts]
  2. Created towers and disks in the DOM [3.0 / 3.0 pts]
  3. Added click handlers to towers and disks [3.0 / 3.0 pts]
  4. Game is functional and there is a win condition. [3.0 / 3.0 pts]

Additional Details

@lewxdev
Copy link
Owner Author

lewxdev commented Feb 2, 2023

Interaction

  1. To select a disk, click or tap it's corresponding tower. The topmost disk will rise and change color, indicating it was successfully selected.
  2. To move a disk, select the tower to move it to. Valid/selectable towers will have a subtly darker base.
  3. The objective is to move all disks to the rightmost tower. A new disk is added each time a puzzle is completed.

NOTE: Hover states only apply to devices with non-mobile devices. (This could use some fine-tuning for cross-platform support: e.g. using touch interactions as a differentiator for disabling hover states)

Keyboard Shortcuts (proposed)

  • 1 Select the first, e.g. start, tower (number row or numpad)
  • 2 Select the second, e.g. offset, tower (number row or numpad)
  • 3 Select the third, e.g. end, tower (number row or numpad)
  • Space Reset the current puzzle
  • X Toggle opening the menu drawer
  • S Toggle displaying disk indices
  • D Toggle the dark mode UI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant