Commit a718d2a

committed

Add screenshot to README.md.

1 parent 19130b5 commit a718d2aCopy full SHA for a718d2a

File tree

2 files changed

+34

-28

lines changed

README.md
assets/images
- ui_screenshot.PNG

2 files changed

+34

-28

lines changed

`‎README.md`

Lines changed: 34 additions & 28 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,56 +4,62 @@ Welcome to the OpenLeetCode Project!`
`4`	`4`
`5`	`5`	`The motivation behind this project is to be able to practice LeetCode problems on a plane without requiring an internet connection (until Starlink ramps up). This project is not intended to replace or replicate leetcode.com.`
`6`	`6`
`7`		`-## Table of Contents`
`8`		`-`
`9`		`-1. [Windows Terminal](#windows-terminal)`
`10`		`- 1. [Build](#build)`
`11`		`- 2. [Run](#run)`
`12`		`- 1. [Windows Terminal](#windows-terminal-1)`
`13`		`- 2. [Unix](#unix)`
`14`		`-2. [How To Use](#how-to-use)`
`15`		`-3. [List of LeetCode Problems](#list-of-leetcode-problems)`
`16`		`-4. [Usage](#usage)`
`17`		`-5. [Note](#note)`
`18`		`-6. [Requirements](#requirements)`
`19`		`-7. [Contributing](#contributing)`
`20`		`-`
`21`		`-## Windows Terminal`
`22`		`-`
`23`		`-### Build`
`24`		`-#### Building without UI`
	`7`	`+## Table of Content`
	`8`	`+- [OpenLeetCode - An open source version of LeetCode](#openleetcode---an-open-source-version-of-leetcode)`
	`9`	`+- [Table of Content](#table-of-content)`
	`10`	`+- [Screenshot](#screenshot)`
	`11`	`+- [Build](#build)`
	`12`	`+ - [Building without UI](#building-without-ui)`
	`13`	`+ - [Building with UI](#building-with-ui)`
	`14`	`+- [Run](#run)`
	`15`	`+ - [CLI - Windows Terminal](#cli---windows-terminal)`
	`16`	`+ - [CLI - Unix](#cli---unix)`
	`17`	`+ - [UI - Windows Terminal](#ui---windows-terminal)`
	`18`	`+ - [UI - Unix](#ui---unix)`
	`19`	`+- [How To Use](#how-to-use)`
	`20`	`+- [List of LeetCode Problems](#list-of-leetcode-problems)`
	`21`	`+- [Usage](#usage)`
	`22`	`+- [Note](#note)`
	`23`	`+- [Requirements](#requirements)`
	`24`	`+ - [Additional Requirements for the UI](#additional-requirements-for-the-ui)`
	`25`	`+- [Contributing](#contributing)`
	`26`	`+`
	`27`	`+`
	`28`	`+## Screenshot`
	`29`	`+![Screenshot](./assets/images/ui_screenshot.png)`
	`30`	`+`
	`31`	`+## Build`
	`32`	`+### Building without UI`
`25`	`33`	```cmd
`26`	`34`	`cmake -B build -DCMAKE_INSTALL_PREFIX=install`
`27`	`35`	`cmake --build build`
`28`	`36`	`cmake --install build --prefix=install`
`29`	`37`	```
`30`		`-#### Building with UI`
	`38`	`+### Building with UI`
`31`	`39`	```cmd
`32`	`40`	`cmake -B build -DCMAKE_INSTALL_PREFIX=install -DBUILD_UI=ON`
`33`	`41`	`cmake --build build`
`34`	`42`	`cmake --install build --prefix=install`
`35`	`43`	```
`36`		`-### Run`
`37`		`-#### CLI - Windows Terminal`
	`44`	`+## Run`
	`45`	`+### CLI - Windows Terminal`
`38`	`46`	```cmd
`39`	`47`	`./problem_builds/openleetcode --language cpp --problem TwoSum`
`40`	`48`	```
`41`		`-#### CLI - Unix`
	`49`	`+### CLI - Unix`
`42`	`50`	```bash
`43`	`51`	`./problem_builds/openleetcode.sh --language cpp --problem TwoSum`
`44`	`52`	```
`45`		`-#### UI - Windows Terminal`
	`53`	`+### UI - Windows Terminal`
`46`	`54`	```cmd
`47`	`55`	`./problem_builds/openleetcodeui`
`48`	`56`	```
`49`		`-#### UI - Unix`
	`57`	`+### UI - Unix`
`50`	`58`	```bash
`51`	`59`	`./problem_builds/openleetcodeui.sh`
`52`	`60`	```
`53`	`61`	`NOTE: UI for unix is yet to be tested.`
`54`	`62`
`55`		`-`
`56`		`-`
`57`	`63`	`## How To Use`
`58`	`64`	`After the build succeeds, the following directory structure will be generated:`
`59`	`65`
`@@ -72,7 +78,7 @@ After the build succeeds, the following directory structure will be generated:`
`72`	`78`	`- launguage`
`73`	`79`	`- cpp`
`74`	`80`
`75`		`-Just like for LeetCode you have one file where you solve the problem. For example, the problem called TwoSum has problems/TwoSum/cpp/solution.cpp. To add a new test cases you can create a file in problems/TwoSum/testcases/ directory with file extension .test and the solution will automatically be tested against it.`
	`81`	`+Just like for LeetCode, you have one file where you solve the problem. For example, the problem called TwoSum has problems/TwoSum/cpp/solution.cpp. To add new test cases, you can create a file in the problems/TwoSum/testcases/ directory with the file extension .test, and the solution will automatically be tested against it.`
`76`	`82`
`77`	`83`	`Each problem is described in the *description.md* file location in the problem's directory. For example *problems/TwoSum/description.md*.`
`78`	`84`
`@@ -104,7 +110,7 @@ The problem names are automatically extracted from the problems folder.`
`104`	`110`	`$ python openleetcode.py --help`
`105`	`111`	`usage: openleetcode.py [-h] [--language {cpp}] [--list-problems] [--list-testcases] [--problem problem_name] [--problem_builds_dir dir] [--testcase testcase_name] [--verbose]`
`106`	`112`
`107`		`-OpenLeetCode problem builder. This script builds and tests a leetcode like problems locally. Currently, it only supports C++ language but it can be extended to support other languages.`
	`113`	`+OpenLeetCode problem builder. This script builds and tests LeetCode-like problems locally. Currently, it only supports the C++ language, but it can be extended to support other languages.`
`108`	`114`
`109`	`115`	`options:`
`110`	`116`	`-h, --help show this help message and exit`

`‎assets/images/ui_screenshot.PNG`

1.04 MB

Loading[フレーム]

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 a718d2a

File tree

2 files changed

2 files changed

`‎README.md`

`‎assets/images/ui_screenshot.PNG`

0 commit comments