Skip to content

Commit

Permalink
add TOC to README.md #4
Browse files Browse the repository at this point in the history
  • Loading branch information
blahosyl authored Apr 20, 2024
1 parent 427a2a5 commit 228c044
Showing 1 changed file with 87 additions and 0 deletions.
87 changes: 87 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,93 @@ See the development progress and further plans on [GitHub Projects](https://gith

## Table of Contents

- [Table of Contents](#table-of-contents)
- [User Experience (UX)](#user-experience--ux-)
* [User goals](#user-goals)
* [Creator goals](#creator-goals)
- [Design](#design)
* [Flow](#flow)
+ [Scope](#scope)
+ [Interaction design](#interaction-design)
- [Minimal typing](#minimal-typing)
- [Information is adjusted for each step](#information-is-adjusted-for-each-step)
- [Alphabetization](#alphabetization)
- [String transformations](#string-transformations)
- [Input in error messages](#input-in-error-messages)
- [Tailored error messages](#tailored-error-messages)
* [Code design](#code-design)
+ [OOP](#oop)
+ [Pantry checker](#pantry-checker)
- [Pantry checker features](#pantry-checker-features)
+ [Y/N validator functions made general-purpose](#y-n-validator-functions-made-general-purpose)
+ [Range validator function made general purpose](#range-validator-function-made-general-purpose)
+ [File organization](#file-organization)
+ [Docstrings and code comments](#docstrings-and-code-comments)
+ [CRUD functionalities](#crud-functionalities)
- [Create](#create)
- [Read](#read)
- [Update](#update)
- [Delete](#delete)
* [Database](#database)
* [Visual design](#visual-design)
+ [Clear screen](#clear-screen)
+ [Pause](#pause)
+ [Emojis](#emojis)
+ [ASCII art](#ascii-art)
+ [Color](#color)
* [Website design](#website-design)
+ [Background image](#background-image)
+ [Button design](#button-design)
+ [Alignment of elements](#alignment-of-elements)
+ [Favicon](#favicon)
+ [Meta tags](#meta-tags)
+ [Design implementation credits](#design-implementation-credits)
+ [Rerolled design elements](#rerolled-design-elements)
+ [Header](#header)
- [Logo](#logo)
- [Author information and GitHub link](#author-information-and-github-link)
+ [Font](#font)
- [Features](#features)
* [Start screen](#start-screen)
* ["Stop program" confirmation](#-stop-program--confirmation)
* ["Start planning" confirmation](#-start-planning--confirmation)
* [Dish selection screen](#dish-selection-screen)
* [Dish selection confirmation](#dish-selection-confirmation)
* [Selected dish and ingredients](#selected-dish-and-ingredients)
* [Modified list of dishes](#modified-list-of-dishes)
* [Automatically end planning loop after last dish](#automatically-end-planning-loop-after-last-dish)
* [Continue without checking the pantry](#continue-without-checking-the-pantry)
* [Start checking the pantry](#start-checking-the-pantry)
* [Pantry check](#pantry-check)
* [Pantry check done](#pantry-check-done)
* [No items needed](#no-items-needed)
* [Shopping list](#shopping-list)
* [End screen](#end-screen)
* ["Start again" message](#-start-again--message)
* [Future features](#future-features)
* [Accessibility](#accessibility)
+ [Color contrasts](#color-contrasts)
- [Technologies used](#technologies-used)
* [Languages used](#languages-used)
* [Python libraries used](#python-libraries-used)
* [Tools used](#tools-used)
* [Development process](#development-process)
- [Deployment](#deployment)
* [Create a database](#create-a-database)
* [Connect to Google Drive & Google Sheets API](#connect-to-google-drive---google-sheets-api)
* [Fork the repository](#fork-the-repository)
* [Deploy to Heroku](#deploy-to-heroku)
- [Testing](#testing)
- [Credits](#credits)
* [Study/lookup sources](#study-lookup-sources)
* [Code credits](#code-credits)
* [Content](#content)
* [Media](#media)
+ [Images](#images)
* [Readme](#readme)

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


## User Experience (UX)

Expand Down

0 comments on commit 228c044

Please sign in to comment.