Skip to content

Commit

Permalink
add TOC to README.md #49
Browse files Browse the repository at this point in the history
  • Loading branch information
blahosyl authored Apr 2, 2024
1 parent 8c4a689 commit 895e0aa
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,94 @@ Developer: [Dr. Sylvia Blaho](https://www.linkedin.com/in/blahosylvia/)
![GitHub contributors](https://img.shields.io/github/contributors/blahosyl/operator-game?color=orange)
![GitHub language count](https://img.shields.io/github/languages/count/blahosyl/operator-game?color=black)

## Table of Contents

* [User Experience](#user-experience)
- [User stories for all users](#user-stories-for-all-users)
- [First-time visitor goals](#first-time-visitor-goals)
- [Returning/frequent visitor goals](#returning-frequent-visitor-goals)
* [Design](#design)
+ [Visual design](#visual-design)
- [Color scheme](#color-scheme)
- [Typography](#typography)
- [Imagery](#imagery)
- [Wireframes](#wireframes)
+ [Flow](#flow)
- [Description of the rules](#description-of-the-rules)
- [Basic gameplay](#basic-gameplay)
- [Evaluation](#evaluation)
- [Difficulty level](#difficulty-level)
- [Scoring rules](#scoring-rules)
* [Features](#features)
+ [Responsivity](#responsivity)
+ [Welcome screen](#welcome-screen)
- [Gameplay Rules section](#gameplay-rules-section)
- [Scoring Rules section](#scoring-rules-section)
- [Start Game button](#start-game-button)
+ [Game Area](#game-area)
- [Question Area](#question-area)
- [Solution Area](#solution-area)
* [Correct guess](#correct-guess)
* [Incorrect guess](#incorrect-guess)
- [Submit button](#submit-button)
+ [Milestone popups](#milestone-popups)
+ [New Game button](#new-game-button)
+ [Perfect Streak counter](#perfect-streak-counter)
+ [Operand Selector toggle](#operand-selector-toggle)
+ [Welcome Screen button](#welcome-screen-button)
+ [Future implementations](#future-implementations)
+ [Accessibility](#accessibility)
* [Technologies used](#technologies-used)
+ [Languages used](#languages-used)
+ [Frameworks, libraries & programs used](#frameworks--libraries---programs-used)
* [Deployment](#deployment)
+ [Local deployment](#local-deployment)
+ [Fork the repository](#fork-the-repository)
+ [Deployment on GitHub Pages](#deployment-on-github-pages)
* [Testing](#testing)
+ [Automated testing](#automated-testing)
- [Code validation](#code-validation)
* [HTML validation with the W3C validator](#html-validation-with-the-w3c-validator)
* [CSS validation with Jigsaw](#css-validation-with-jigsaw)
* [JavaScript validation with JSHint](#javascript-validation-with-jshint)
- [Lighthouse](#lighthouse)
* [Lighthouse performance testing](#lighthouse-performance-testing)
* [Lighthouse accessibility testing](#lighthouse-accessibility-testing)
+ [Manual testing](#manual-testing)
- [Testing user stories](#testing-user-stories)
- [User stories for all users](#user-stories-for-all-users-1)
- [First-time visitor goals](#first-time-visitor-goals-1)
- [Returning/frequent visitor goals](#returning-frequent-visitor-goals-1)
- [Full testing of functionalities](#full-testing-of-functionalities)
* [Devices](#devices)
* [Browsers](#browsers)
* [Responsivity testing](#responsivity-testing)
* [Welcome screen testing](#welcome-screen-testing)
* [Game Area testing](#game-area-testing)
* [New Game button testing](#new-game-button-testing)
* [Milestone "popups" testing](#milestone--popups--testing)
* [Perfect streak counter testing](#perfect-streak-counter-testing)
* [Operand selector toggle testing](#operand-selector-toggle-testing)
* [Welcome Screen button testing](#welcome-screen-button-testing)
+ [Accessibility testing](#accessibility-testing)
- [Automated accessibility testing](#automated-accessibility-testing)
- [Manual accessibility testing](#manual-accessibility-testing)
* [Color contrast testing](#color-contrast-testing)
* [Web Disability Simulator](#web-disability-simulator)
+ [Bugs](#bugs)
- [Known bugs](#known-bugs)
- [Solved bugs](#solved-bugs)
* [Credits](#credits)
+ [Study materials](#study-materials)
+ [Code](#code)
+ [Content](#content)
+ [Media](#media)
- [Images](#images)
+ [Readme](#readme)
+ [Acknowledgements](#acknowledgements)

<small><i><a href='http://github.com/3kh0/readme-toc/'>Table of contents generated with readme-toc</a></i></small>


## User Experience

Expand Down

0 comments on commit 895e0aa

Please sign in to comment.