Commit 1a3910d

committed

Add Table of Contents to README.md and a link to docs/index.md.

1 parent 59353c0 commit 1a3910dCopy full SHA for 1a3910d

File tree

1 file changed

+23

-2

lines changed

README.md

1 file changed

+23

-2

lines changed

`‎README.md`

Lines changed: 23 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,25 @@`
`1`	`1`	`OpenLeetCode - An open source version of LeetCode`
`2`	`2`	`--------------------------------------------------------`
	`3`	`+Welcome to the OpenLeetCode Project!`
	`4`	`+`
	`5`	`+The motivation behind this project is to be able to leetcode on the plane without having internet connection. It is by no means meant to replace or copy leetcode.com.`
	`6`	`+`
	`7`	`+`
	`8`	`+The motivation behind this project is to be able to practice LeetCode problems on a plane without requiring an internet connection (untill Starlink ramps up). It is by no means intended to replace or replicate leetcode.com.`
	`9`	`+`
	`10`	`+## Table of Contents`
	`11`	`+`
	`12`	`+1. [Windows Terminal](#windows-terminal)`
	`13`	`+ 1. [Build](#build)`
	`14`	`+ 2. [Run](#run)`
	`15`	`+ 1. [Windows Terminal](#windows-terminal-1)`
	`16`	`+ 2. [Unix](#unix)`
	`17`	`+2. [How To Use](#how-to-use)`
	`18`	`+3. [List of LeetCode Problems](#list-of-leetcode-problems)`
	`19`	`+4. [Usage](#usage)`
	`20`	`+5. [Note](#note)`
	`21`	`+6. [Requirements](#requirements)`
	`22`	`+7. [Contributing](#contributing)`
`3`	`23`
`4`	`24`	`## Windows Terminal`
`5`	`25`
`@@ -9,7 +29,6 @@ cmake -B build -DCMAKE_BUILD_TYPE=Debug -DPROBLEM_BUILDS_NAME=problem_builds`
`9`	`29`	`cmake --build build`
`10`	`30`	`cmake --install build --config Debug`
`11`	`31`	```
`12`		`-`
`13`	`32`	`### Run`
`14`	`33`	`#### Windows Terminal`
`15`	`34`	```cmd
`@@ -100,4 +119,6 @@ This project requires the following to run:`
`100`	`119`	`- Git`
`101`	`120`
`102`	`121`	`## Contributing`
`103`		`-Feel free to contribute with code, test cases, or even code reviews.`
	`122`	`+Feel free to contribute with code, test cases, or even code reviews.`
	`123`	`+`
	`124`	`+For a more in-depth guide on how to contribute and information about the inner workings of OpenLeetCode, please refer to the [Docs](docs/index.md).`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 1a3910d

File tree

1 file changed

1 file changed

`‎README.md`

0 commit comments