Skip to content

Commit d3a141c

Browse files
authored
Addressing issue #24
Added more information on how to use the generator and prerequisites
1 parent 4135a69 commit d3a141c

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,23 @@ I personally use it to track my grinding progress.
1818
![photo_2021-09-29_08-58-21 jpg 2](https://user-images.githubusercontent.com/1616237/135676123-106871e0-bc8e-4d23-acef-c27ebe034ecf.png)
1919
![photo_2021-09-29_08-58-23 jpg 2](https://user-images.githubusercontent.com/1616237/135676125-90067ea3-e111-49da-ae13-7bce81040c37.png)
2020

21+
## Prerequisites
22+
1. [python3.8+](https://www.python.org/downloads/) installed
23+
2. [python virtualenv](https://pypi.org/project/virtualenv/) installed
24+
3. [git cli](https://github.com/git-guides/install-git) installed
25+
4. [GNU make](https://www.gnu.org/software/make/) installed (optional, can run the script directly)
26+
5. \*nix operating system (Linux, MacOS, FreeBSD, ...). Should also work for Windows, but commands will be different. I'm not a Windows expert, so can't figure out how to make it work there, but contributions are welcome.
27+
28+
## How to run
29+
First download the source code
30+
```
31+
git clone https://github.com/prius/leetcode-anki.git
32+
cd leetcode-anki
33+
```
2134

22-
## Installation
23-
First initialize and activate python virtualenv somewhere
35+
After that initialize and activate python virtualenv somewhere
2436
```
25-
virtualenv -p python3 leetcode-anki
37+
virtualenv -p python leetcode-anki
2638
. leetcode-anki/bin/activate
2739
```
2840

@@ -31,7 +43,7 @@ Then initialize session id variable. You can get it directly from your browser (
3143
export LEETCODE_SESSION_ID="yyy"
3244
```
3345

34-
And then run
46+
And finally run
3547
```
3648
make generate
3749
```

0 commit comments

Comments
 (0)