Skip to content

Commit

Permalink
doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
kaiwk committed May 31, 2020
1 parent 4a2818b commit ef59344
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 28 deletions.
54 changes: 26 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,32 @@

LeetCode brings you offer, and now Emacs brings you LeetCode!

# Usage

![screencast](images/screencast.gif)

1. Execute `leetcode` command, and in problem list buffer:

| keymap | command |
|--------|----------------------------------------|
| n | cursor move down |
| p | cursor move up |
| s | filter problems by regex |
| t | filter problems by tag |
| d | filter problems by difficulty |
| / | clear filters |
| g | refresh without fetching from LeetCode |
| G | refresh all data |
| RET | show current problem description |

2. Press `<RET>`, show problem description, move cursor to "solve it", press
`<RET>` again, start coding!

3. After finishing your code, you can edit testcase and execute `leetcode-try`
or execute `leetcode-submit`.

![leetcode-submit](images/leetcode-submit.png)

# Installation

- Vanilla Emacs: `package-install` it from melpa directly
Expand Down Expand Up @@ -41,34 +67,6 @@ You can save solution by setting `leetcode-save-solutions`:
(setq leetcode-directory "~/leetcode")
```

# Usage

1. Execute `leetcode` command.

![leetcode](images/leetcode.png)

In leetcode problems list buffer:

| keymap | command |
|--------|----------------------------------------|
| n | cursor move down |
| p | cursor move up |
| s | filter problems by regex |
| t | filter problems by tag |
| d | filter problems by difficulty |
| / | clear filters |
| g | refresh without fetching from LeetCode |
| G | refresh all data |
| RET | show current problem description |

2. Press `<RET>`, show problem description, move cursor to "solve it", press
`<RET>` again, start coding!

3. After finishing your code, you can edit testcase and execute `leetcode-try`
or execute `leetcode-submit`.

![leetcode-submit](images/leetcode-submit.png)

# Debug

Call `leetcode-toggle-debug`, log will output in `*leetcode-log*` buffer.
Expand Down
Binary file removed images/leetcode.png
Binary file not shown.
Binary file added images/screencast.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ef59344

Please sign in to comment.