Skip to content

Commit 0470b77

Browse files
committed
Update readme with diagram and emojis
1 parent fbfe7fb commit 0470b77

File tree

4 files changed

+28
-33
lines changed

4 files changed

+28
-33
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# Leetcode Study Tool
1+
# 💻 Leetcode Study Tool
22
![Tests Status](https://github.com/johnsutor/leetcode-study-tool/workflows/Tests/badge.svg)
33
![Style Status](https://github.com/johnsutor/leetcode-study-tool/workflows/Style/badge.svg)
44
[![Python Versions](https://img.shields.io/pypi/pyversions/leetcode-study-tool)](https://pypi.org/project/leetcode-study-tool/)
55
[![PyPi](https://img.shields.io/pypi/v/leetcode-study-tool)](https://pypi.org/project/leetcode-study-tool/)
66
![contributions welcome](https://img.shields.io/badge/contributions-welcome-blue.svg?style=flat)
77

8+
![Leetcode Study Tool Diagram](./static/leetcode_study_tool_diagram.png)
9+
810
This package lets you get grokking as quickly as possible with Leetcode. It provides a command-line tool for interracting with Leetcode to create either an Excel file or Anki flashcards for study. Currently, this tool supports taking in a list of leetcode question slugs or URLs or popular study sets (including the [Blind 75](https://www.teamblind.com/post/New-Year-Gift---Curated-List-of-Top-75-LeetCode-Questions-to-Save-Your-Time-OaM1orEU), [Grind 75](https://www.techinterviewhandbook.org/grind75), and [Neetcode 150](https://neetcode.io/practice)).
911

10-
## Why?
12+
## 🤔 Why?
1113
This package was created as an opinionated alternative to other existing packages (as listed at the bottom of this README).
1214

13-
## Installation
15+
## 📥 Installation
1416
```shell
1517
$ pip install leetcode-study-tool
1618
```
1719

18-
## Usage
20+
## 💻 Usage
1921
```shell
2022
usage: leetcode-study-tool [-h]
2123
(--url URL | --file FILE | --preset {blind_75,grind_75,grind_169,neetcode_150,neetcode_all})
@@ -41,7 +43,7 @@ options:
4143
The language to generate problem(s) for. (default: None)
4244
```
4345

44-
## Example
46+
## 💡 Example
4547
In the simplest case, if you want to [Grok](https://www.reddit.com/r/leetcode/comments/t5xqb6/how_to_use_grokking/) the most commonly asked questions, you should generate from a preset. For example, generating Anki cards from the [Grind 75](https://www.techinterviewhandbook.org/grind75) is as simple as
4648
```shell
4749
$ leetcode-study-tool -p grind_75
@@ -54,13 +56,13 @@ which will generate the file `output.txt`. We can then open Anki to import these
5456

5557
![anki demo](static/anki-demo.gif)
5658

57-
## Anki
59+
## 📒 Anki
5860
When generating an Anki output, the resulting "cards" are saved as a `.txt` file. These cards include three fields:
5961
1. The front of the study card, containing the question ID, Title, URL, and problem description
6062
2. The publicly available solutions (and NeetCode solution, if available)
6163
3. The tags associated with the problem (i.e., if the problem involves a hash map, arrays, etc...)
6264

63-
## Excel
65+
## 📊 Excel
6466
When generating an Excel output, the resulting questions are saved in an `.xlsx` file. Each problem includes the following fields:
6567
1. ID of the leetcode question
6668
2. Title of the leetcode question
@@ -71,7 +73,7 @@ When generating an Excel output, the resulting questions are saved in an `.xlsx`
7173
7. Solution links for the problem (if they are reachable)
7274
8. Companies that have asked this question recently in interviews (if they are reachable)
7375

74-
## Roadmap
76+
## 🛣 Roadmap
7577
- [X] Use TQDM to show card generation progress
7678
- [X] Add support for exporting to an excel sheet
7779
- [X] Add support for showing neetcode solutions on the back of the card as a
@@ -83,7 +85,7 @@ link
8385
- [ ] Allow for the definition of custom formatters and outputs (including which fields are included or excluded)
8486
- [ ] Reach 90% test coverage
8587

86-
## Other Usefull Stuff
88+
## 🔎 Other Usefull Stuff
8789
- [Remember anything with Anki](https://foggymountainpass.com/anki-essentials/)
8890
- [Leetcode Anki Card Generator](https://github.com/fspv/leetcode-anki)
8991
- [Leetcode API](https://github.com/fspv/python-leetcode)
291 KB
Loading

static/leetcode_study_tool_diagram.svg

Lines changed: 17 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy