Skip to content

Commit 8ed9b2b

Browse files
Hedwig-FangHedwig-Fang
authored
Merge pull request #40 from EternalHeartTeam/dev-think
docs: simplified doc
2 parents 679c313 + 7911e35 commit 8ed9b2b

File tree

3 files changed

+46
-61
lines changed

3 files changed

+46
-61
lines changed

‎README.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,8 @@ Then, `leetcode-practice` is all you need!
2828
| -------- | :---------------------------------------------: |
2929
| nodejs | lts |
3030
| git | lts |
31-
| computer | Ability to run Chrome and a code editor |
3231
| patience | A heart that can persist in practicing problems |
3332

34-
> Note: nodejs: [Node.js Installation Guide](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
35-
>
36-
> git: [Git Download Page](https://git-scm.com/downloads)
37-
3833
### 1. How Can I Use It? (Three Options for You to Choose From)
3934

4035
#### Option A. Command-Line Interface (CLI) (Recommended)
@@ -231,20 +226,11 @@ npm i --save-dev leetcode-practice
231226

232227
| Command | Explanation |
233228
| ------- | --------------------------------------------------------------------------------------------------------------------------------- |
234-
| lc | Core creation command, supports three creation modes (daily question, specified question, random question) for creating questions |
235229
| lk | Core checking command, supports three modes corresponding to the question for checking questions |
236230
| lf | Core search command, which can quickly search for the question you want based on prompts |
231+
| lc | Core creation command, supports three creation modes (daily question, specified question, random question) for creating questions |
237232

238-
#### [1]. lc
239-
240-
| Short Parameter | Full Parameter | Explanation |
241-
| ---------------------- | -------------- | ----------------------------------------------------------------------- |
242-
| No parameter / `-t` | `--today` | Create today's daily question |
243-
| Question number / `-i` | `--identity` | Create the question corresponding to the specified number |
244-
| `-r` | `--random` | Create a random question that has not appeared in the current directory |
245-
| `-e` | `--easy` | Interactive creation of questions |
246-
247-
#### [2]. lk
233+
#### [1]. lk
248234

249235
| Short Parameter | Full Parameter | Explanation |
250236
| ---------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -256,12 +242,21 @@ npm i --save-dev leetcode-practice
256242
> Note: When checking, please pay attention to what mode to use for checking, and make sure that you have performed the corresponding mode creation operation.
257243
> The specified ID mode is an exception because it will check whether the specified ID exists in the current working directory.
258244
259-
#### [3]. lf
245+
#### [2]. lf
260246

261247
| Short Parameter | Full Parameter | Explanation |
262248
| --------------- | -------------- | ------------------------------------------------------------------------- |
263249
| No parameter | None | Enter interactive search, and search or filter questions based on prompts |
264250

251+
#### [3]. lc
252+
253+
| Short Parameter | Full Parameter | Explanation |
254+
| ---------------------- | -------------- | ----------------------------------------------------------------------- |
255+
| No parameter / `-t` | `--today` | Create today's daily question |
256+
| Question number / `-i` | `--identity` | Create the question corresponding to the specified number |
257+
| `-r` | `--random` | Create a random question that has not appeared in the current directory |
258+
| `-e` | `--easy` | Interactive creation of questions |
259+
265260
#### [4]. General Parameters
266261

267262
| Short Parameter | Full Parameter | Explanation |

‎README_CN.md

+17-22
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,11 @@
2424

2525
### 0. 预备条件
2626

27-
| 工具 | 备注 |
28-
| -------- | :------------------------: |
29-
| nodejs | lts |
30-
| git | lts |
31-
| computer | 能够运行chrome和代码编辑器 |
32-
| patience | 一颗能够坚持刷题的心 |
33-
34-
> note: nodejs:[nodejs安装向导](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
35-
>
36-
> git:[git下载地址](https://git-scm.com/downloads)
27+
| 工具 | 备注 |
28+
| -------- | :------------------: |
29+
| nodejs | lts |
30+
| git | lts |
31+
| patience | 一颗能够坚持刷题的心 |
3732

3833
### 1. 我可以怎么用? (三种方案供你选择)
3934

@@ -236,20 +231,11 @@ npm i --save-dev leetcode-practice
236231

237232
| 指令 | 说明 |
238233
| ---- | ------------------------------------------------------------------------------------------------------ |
239-
| lc | 核心创建指令，支持三种创建模式 ( 每日一题、指定题目、随机题目 ) 进行题目的创建 |
240234
| lk | 核心检查指令，支持三种模式对应的题目检测 |
241235
| lf | 核心查找指令，可以快捷的搜索你想要的题目，支持Hot100，关键词搜索，条件筛选等模式进行搜索题目并支持创建 |
236+
| lc | 核心创建指令，支持三种创建模式 ( 每日一题、指定题目、随机题目 ) 进行题目的创建 |
242237

243-
#### [1].lc
244-
245-
| 简单参数 | 完整参数 | 说明 |
246-
| ------------- | ------------ | -------------------------------- |
247-
| 无参数/`-t` | `--today` | 创建今日的每日一题 |
248-
| 题目编号/`-i` | `--identity` | 创建指定编号对应的题目 |
249-
| `-r` | `--random` | 创建当前目录下未出现过的随机题目 |
250-
| `-e` | `--easy` | 交互式创建题目 |
251-
252-
#### [2].lk
238+
#### [1].lk
253239

254240
| 简单参数 | 完整参数 | 说明 |
255241
| ------------- | ------------ | ---------------------------------------------------------------------- |
@@ -261,12 +247,21 @@ npm i --save-dev leetcode-practice
261247
> 注意: 当你检测的时候需要注意，使用什么模式去检查，请确保你已经执行过对应模式的创建操作。
262248
> 指定编号模式除外，因为会优先检查指定的id是否在当前工作目录存在。
263249
264-
#### [3].lf
250+
#### [2].lf
265251

266252
| 简单参数 | 完整参数 | 说明 |
267253
| -------- | -------- | -------------------------------------------------- |
268254
| 无参数 | 无 | 进入交互式查询，可根据提示搜索或筛选题目并创建题目 |
269255

256+
#### [3].lc
257+
258+
| 简单参数 | 完整参数 | 说明 |
259+
| ------------- | ------------ | -------------------------------- |
260+
| 无参数/`-t` | `--today` | 创建今日的每日一题 |
261+
| 题目编号/`-i` | `--identity` | 创建指定编号对应的题目 |
262+
| `-r` | `--random` | 创建当前目录下未出现过的随机题目 |
263+
| `-e` | `--easy` | 交互式创建题目 |
264+
270265
#### [4].通用参数
271266

272267
| 简单参数 | 完整参数 | 说明 |

‎README_JP.md

+17-22
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,11 @@
2424

2525
### 0.前提条件
2626

27-
| ツール | 備考 |
28-
| ------------ | :----------------------------------------------: |
29-
| nodejs | lts |
30-
| git | lts |
31-
| コンピュータ | chromeとコードエディタを実行できる必要があります |
32-
| 我慢 | 問題を解き続けるための心 |
33-
34-
> ノート: nodejs:[nodejsのインストールガイド](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
35-
>
36-
> git:[gitのダウンロードリンク](https://git-scm.com/downloads)
27+
| ツール | 備考 |
28+
| ------ | :----------------------: |
29+
| nodejs | lts |
30+
| git | lts |
31+
| 我慢 | 問題を解き続けるための心 |
3732

3833
### 1. どう使えるのか？ (3つの選択肢)
3934

@@ -227,20 +222,11 @@ npm i --save-dev leetcode-practice
227222

228223
| コマンド | 説明 |
229224
| -------- | ------------------------------------------------------------------------------------------------------------------------- |
230-
| lc | 主要な作成コマンドであり、3つの作成モード（毎日の問題、指定された問題、ランダムな問題）をサポートし、問題の作成を行います |
231225
| lk | 主要なチェックコマンドであり、3つのモードに対応する問題のチェックを行います |
232226
| lf | 主要な検索コマンドであり、Hot100、キーワード検索、条件検索などのモードで問題を検索し、問題を作成します |
227+
| lc | 主要な作成コマンドであり、3つの作成モード（毎日の問題、指定された問題、ランダムな問題）をサポートし、問題の作成を行います |
233228

234-
#### [1]. lc (問題の作成)
235-
236-
| 簡易パラメータ | 完全パラメータ | 説明 |
237-
| -------------- | -------------- | -------------------------------------------- |
238-
| 無し/`-t` | `--today` | 今日の毎日の問題を作成します。 |
239-
| 問題番号/`-i` | `--identity` | 指定された番号に対応する問題を作成します。 |
240-
| `-r` | `--random` | まだ現れていないランダムな問題を作成します。 |
241-
| `-e` | `--easy` | インタラクティブに問題を作成します。 |
242-
243-
#### [2]. lk (問題のチェック)
229+
#### [1]. lk (問題のチェック)
244230

245231
| 簡易パラメータ | 完全パラメータ | 説明 |
246232
| -------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ |
@@ -252,12 +238,21 @@ npm i --save-dev leetcode-practice
252238
> 注意: チェックする際は、どのモードを使用するかに注意してください。対応するモードの作成操作をすでに実行したことを確認してください。
253239
> 指定番号モードは例外であり、作成されていない問題をチェックすることもできます。
254240
255-
#### [3]. lf (問題の検索)
241+
#### [2]. lf (問題の検索)
256242

257243
| 簡易パラメータ | 完全パラメータ | 説明 |
258244
| -------------- | -------------- | -------------------------------------------------------------------------------------------------------- |
259245
| 無し | 無し | インタラクティブにクエリに入り、ヒントに従って問題を検索したりフィルタリングしたりして問題を作成します。 |
260246

247+
#### [3]. lc (問題の作成)
248+
249+
| 簡易パラメータ | 完全パラメータ | 説明 |
250+
| -------------- | -------------- | -------------------------------------------- |
251+
| 無し/`-t` | `--today` | 今日の毎日の問題を作成します。 |
252+
| 問題番号/`-i` | `--identity` | 指定された番号に対応する問題を作成します。 |
253+
| `-r` | `--random` | まだ現れていないランダムな問題を作成します。 |
254+
| `-e` | `--easy` | インタラクティブに問題を作成します。 |
255+
261256
#### [4]. 汎用パラメータ
262257

263258
| 簡易パラメータ | 完全パラメータ | 説明 |

0 commit comments

Comments
 (0)