Skip to content

Commit a324ef3

Browse files
authored
Update README.md
1 parent da78190 commit a324ef3

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# LeetcodeAP
22

3-
An Archipelago Hint Client for Leetcode.
3+
An Archipelago hint client for Leetcode.
4+
5+
## Installation
6+
7+
Download `leetcode-ap-win.zip` in the latest release [here](https://github.com/redside100/leetcode-ap/releases/tag/1.0.0).
8+
9+
Unpack the zip file, then run `LeetcodeAP.exe`.
10+
11+
For Linux and Mac support, consider building it from the source on the respective platform.
12+
13+
```bash
14+
npm install
15+
npm run build:linux
16+
npm run build:mac
17+
```
18+
19+
20+
## Usage
21+
22+
Connect to the Archipelago server. You'll need:
23+
24+
- The server host
25+
- The server port
26+
- The slot you want to hint for
27+
- The optional server password
28+
- Your **Leetcode** username for tracking
29+
30+
Once connected, start solving Leetcode questions! Do note that at the time of connecting, your last 20 submissions are already taken into account, so make sure to solve new questions.
31+
32+
Each new **accepted** submission will grant a hint to the slot you're connected to.
33+
34+
Each **rejected** submission will cause a death link trigger, if the "Death Link" option is checked.
35+
36+
## Gallery
37+
![image](https://github.com/user-attachments/assets/fb17267d-f334-4eb7-8f33-6fc011afbd0b)
38+
39+
![image](https://github.com/user-attachments/assets/fe407515-408b-4ac7-9abd-eed0fac584c4)

0 commit comments

Comments
 (0)