docs:add examples to explain how to use

Author: wh131462

README.md

@@ -1,211 +1,42 @@
 # Leetcode practice
 
-在力扣练习平台!开始你的每日一题!
+[中文文档](docs/README_CN.md)|**英文文档**|[日文文档](docs/README_JP.md)|[韩文文档](docs/README_KR.md)
 
-在编辑器中编写你的代码,简单有效的执行和计时!
+## Introduction
 
-我们的目标就是让所有人:
-> 只用专注于代码的实现,而非繁琐的输入输出!
+A brief introduction: "Start practicing your daily LeetCode questions in the editor!"
 
-![CLI-lc](resources/images/cli-lc.png)
+If you want to write your solutions in the editor...
 
-## How to use for your self?
+If you want to quickly access daily questions...
 
-### Plan A (Recommended)
-The best way to use is by using the `lk/lf/lc` command in your terminal.
+If you want to create your own solution repository...
 
-### Plan B (Supported)
-You can also use the `fork` command on github.com to create your own repository.
+Then, leetcode-practice will meet all your needs!
 
-### Plan C (Supported)
-We also publish a plugin for `WebStorm` and `VS Code`. You can easily use it to create your question.
+## Preview
 
-## Preparation
+![CLI-lc](resources/images/lc-cli-h.png)
 
-只需要一个node环境即可.([如何安装node?点我了解](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs))
+## How should I use it? (Three options for you to choose from)
 
-| 依赖包    | 版本    |
-|--------|-------|
-| nodejs | `lts` |
+### Option A: CLI (Recommended)
 
-## Installation
+The best and most flexible way to use it is to use our CLI in the terminal. You can create and check your solutions using three core commands: `lk`, `lf`, and `lc`.
 
-### Global installation for cli (for plan A)
-1. npm install -g leetcode-practice
-### Using fork to make your leetcode-practice repository (for plan B)
+### Option B: Fork (Supported)
 
-### Install plugin on your editor[WebStorm/VS code] (for plan C) 
+You can also use GitHub's fork feature to create a copy of our project. Then, you can directly use the built-in commands within the project to create and check solutions.
 
+### Option C: Plugin (Supported)
 
-## Usage
-### 0. 安装依赖
+You can also use our `leetcode-practice` plugin available in the plugin marketplace for interactive creation and checking of solutions. (Supported on two popular editors: `WebStorm` and `VS Code`)
 
-```shell
-yarn install # 或者任意你喜欢的包管理工具，如
-pnpm install
-```
+## Prerequisites
 
-### 1. 获取今天的题目
+For any option, you only need a Node environment. ([Don't know how to install Node? Click here to learn more](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs))
 
-```shell
-yarn leet-create
-```
+| Dependency | Version |
+|------------|---------|
+| Node.js    | `lts`   |
 
-会通过接口获取今日题目，并会在`src`目录下根据`题目的id`+`题目的英文翻译`创建一个目录，并将今日题目和基础示例代码填充到`index.js`中。
-
-![创建目录](resources/images/leet-create-0.png)
-![填充文件](resources/images/leet-create-1.png)
-
-### 2. 检验今天的题目
-
-```shell
-yarn leet-check
-```
-
-此指令会根据今天的题目信息去执行对应的题目文件，输出结果。
-
-```shell
-yarn leet-check 
-
-[leet-check]检测题目:2744.find-maximum-number-of-string-pairs
-执行结果:
-┌─────────┬──────────┬──────────┬──────────┬────────────┬───────────┐
-│ (index) │ 测试结果 │ 预期结果 │ 执行结果 │  执行用时  │ 内存占用  │
-├─────────┼──────────┼──────────┼──────────┼────────────┼───────────┤
-│    0    │  '通过'  │   '2'    │   '2'    │ '0.2113ms' │ '1.68 KB' │
-│    1    │  '通过'  │   '1'    │   '1'    │ '0.0195ms' │ '1.73 KB' │
-│    2    │  '通过'  │   '0'    │   '0'    │ '0.0091ms' │ '1.80 KB' │
-└─────────┴──────────┴──────────┴──────────┴────────────┴───────────┘
-点击跳转到题目提交:https://leetcode.cn/problems/find-maximum-number-of-string-pairs/
-
-Done in 0.18s.
-
-```
-
-![检测题目](resources/images/leet-check.png)
-
-### 3. 创建自己想要练习的题目
-
-```shell
-# 可以使用你喜欢的任意包管理工具,例如 `pnpm`/`npm`
-yarn leet-create -i [题目编号或者名称]
-
-# e.g.
-yarn leet-create -i 1314
-#注意如果遇到id带空格的题目，请使用字符串包裹
-# e.g.
-yarn leet-create -i "LCP 29"
-```
-
-然后会在目录中创建一个模板js文件,目录结构为:
-
-```shell
--src
-└── 1314
-  └── index.js # 模板js文件 可以替换题目
-```
-
-![1314cmd.png](resources/images/1314-cmd.png)
-![1314.png](resources/images/1314.png)
-![1314详情.png](resources/images/1314-detail.png)
-
-### 4. 检验自己想要练习的结果
-
-```shell
-# 可以使用你喜欢的任意包管理工具,例如 `pnpm`/`npm`
-yarn leet-check -i [题目编号或者名称]
-
-e.g.
-yarn leet-check -i 1314
-```
-
-会出现其用时以及内存占用:
-
-```shell
-D:\GitHub\leetcode-practice> yarn leet-check -i 1314 
-yarn run v1.22.19
-$ node common/scripts/check.js -i 1314
-[leet-check]检测题目:1314.matrix-block-sum
-执行结果:
-┌─────────┬──────────┬──────────────────────────────────────┬──────────────────────────────────────┬────────────┬───────────┐
-│ (index) │ 测试结果 │               预期结果               │               执行结果               │  执行用时  │ 内存占用  │
-├─────────┼──────────┼──────────────────────────────────────┼──────────────────────────────────────┼────────────┼───────────┤
-│    0    │  '通过'  │ '[[12,21,16],[27,45,33],[24,39,28]]' │ '[[12,21,16],[27,45,33],[24,39,28]]' │ '0.2553ms' │ '2.05 KB' │
-│    1    │  '通过'  │ '[[45,45,45],[45,45,45],[45,45,45]]' │ '[[45,45,45],[45,45,45],[45,45,45]]' │ '0.0224ms' │ '2.13 KB' │
-└─────────┴──────────┴──────────────────────────────────────┴──────────────────────────────────────┴────────────┴───────────┘
-点击跳转到题目提交:https://leetcode.cn/problems/matrix-block-sum/
-
-Done in 0.18s.
-
-```
-
-当然如果你之前执行了`leet-create -i`指令创建的题目，也可以不指定号码，系统会自动读取上一个指定创建的题目进行监测。
-
-```shell
-D:\GitHub\leetcode-practice> yarn leet-check -i     
-yarn run v1.22.19
-$ node common/scripts/check.js -i
-[leet-check]检测题目:1314.matrix-block-sum
-执行结果:
-┌─────────┬──────────┬──────────────────────────────────────┬──────────────────────────────────────┬────────────┬───────────┐
-│ (index) │ 测试结果 │               预期结果               │               执行结果               │  执行用时  │ 内存占用  │
-├─────────┼──────────┼──────────────────────────────────────┼──────────────────────────────────────┼────────────┼───────────┤
-│    0    │  '通过'  │ '[[12,21,16],[27,45,33],[24,39,28]]' │ '[[12,21,16],[27,45,33],[24,39,28]]' │ '0.2537ms' │ '2.05 KB' │
-│    1    │  '通过'  │ '[[45,45,45],[45,45,45],[45,45,45]]' │ '[[45,45,45],[45,45,45],[45,45,45]]' │ '0.0231ms' │ '2.13 KB' │
-└─────────┴──────────┴──────────────────────────────────────┴──────────────────────────────────────┴────────────┴───────────┘
-点击跳转到题目提交:https://leetcode.cn/problems/matrix-block-sum/
-
-Done in 0.19s.
-
-```
-
-![1314-check.png](resources/images/1314-check.png)
-
-### 5. 获取随机题目
-
-```shell
-yarn leet-create -r
-```
-
-会获取一个当前src目录中未出现过的题目并创建:
-
-```shell
- D:\GitHub\leetcode-practice> yarn leet-create -r     
-yarn run v1.22.19
-$ node common/scripts/create.js -r
-[fulfillQuestion]题目[43][字符串相乘]已完成填充.
-Done in 1.78s.
-```
-
-### 6. 检验随机题目
-
-```shell
-# 可以使用你喜欢的任意包管理工具,例如 `pnpm`/`npm`
-yarn leet-check -r
-```
-
-会检验刚刚创建出的随机题目:
-
-```shell
- D:\GitHub\leetcode-practice> yarn leet-check -r
-yarn run v1.22.19
-$ node common/scripts/check.js -r
-[leet-check]检测当前随机题目:43.multiply-strings
-执行结果:
-┌─────────┬──────────┬───────────┬───────────┬────────────┬───────────┐
-│ (index) │ 测试结果 │ 预期结果  │ 执行结果  │  执行用时  │ 内存占用  │
-├─────────┼──────────┼───────────┼───────────┼────────────┼───────────┤
-│    0    │  '通过'  │   '"6"'   │   '"6"'   │ '0.2153ms' │ '1.76 KB' │
-│    1    │  '通过'  │ '"56088"' │ '"56088"' │ '0.0232ms' │ '2.02 KB' │
-└─────────┴──────────┴───────────┴───────────┴────────────┴───────────┘
-点击跳转到题目提交:https://leetcode.cn/problems/multiply-strings/
-
-Done in 0.19s.
-
-```
-
-## Contributor
-
-[<img src="https://avatars.githubusercontent.com/u/48346853" style="border-radius:50%;" width="30" height="30" alt="EternalHeart"/>](https://github.com/wh131462)
-[<img src="https://avatars.githubusercontent.com/u/61453917" style="border-radius:50%;" width="30" height="30" alt="SmartTeddy"/>](https://github.com/SmallTeddy)
-[<img src="https://avatars.githubusercontent.com/u/35305691" style="border-radius:50%;" width="30" height="30" alt="Hedwig-Fang"/>](https://github.com/Hedwig-Fang)

bin/lc.js

@@ -1,7 +1,7 @@
 #! /usr/bin/env node
 import {program} from "commander";
 import {artFontLogo} from "#resources/text/art-font-logo.js";
-import {examples} from "#resources/text/examples.js";
+import {lcExamples} from "#resources/text/examples.js";
 import {love} from "#resources/text/love.js";
 import {aim} from "#resources/text/aim.js";
 import {referMode} from "#common/utils/create-check/refer-mode.js";
@@ -23,7 +23,7 @@ const version = process.env.VERSION??'0.0.0';
 program
     .version(version)
     .description(`${description}\n${artFontLogo}\n${aim}`)
-    .addHelpText('after', examples+love)
+    .addHelpText('after', lcExamples+love)
     .arguments("[identity]")
     .option('-t, --today', 'Get a question today.')
     .option('-i, --identity <identity>', 'Specify a question by identity.')

bin/lk.js

@@ -1,7 +1,7 @@
 #! /usr/bin/env node
 import {program} from "commander";
 import {artFontLogo} from "#resources/text/art-font-logo.js";
-import {examples} from "#resources/text/examples.js";
+import {lkExamples} from "#resources/text/examples.js";
 import {love} from "#resources/text/love.js";
 import {aim} from "#resources/text/aim.js";
 import {referMode} from "#common/utils/create-check/refer-mode.js";
@@ -21,7 +21,7 @@ const version = process.env.VERSION ?? '0.0.0';
 program
     .version(version)
     .description(`${description}\n${artFontLogo}\n${aim}`)
-    .addHelpText('after', examples + love)
+    .addHelpText('after', lkExamples + love)
     .arguments("[identity]")
     .option('-t, --today', 'Check the question today.')
     .option('-i, --identity <identity>', 'Check the specified question by identity.')

docs/README_CN.md

@@ -16,7 +16,7 @@
 
 ## 预览
 
-![CLI-lc](../resources/images/cli-lc.png)
+![CLI-lc](../resources/images/lc-cli-h.png)
 
 ## 我应该怎么使用？（三种方案供你选择）
 

resources/images/cli-lc.png

@@ -1,4 +1,5 @@
 export const description = `
 A powerful practice platform for leetcode.
 CLI / Template Project / Plugin, you can create question by any way you like.
+See https://github.com/wh131462/leetcode-practice
 `;

resources/images/lc-cli-h.png

@@ -1,9 +1,50 @@
-export const examples = `
+export const lcExamples = `
 Examples:
-  $ lc          // Get a question today
-  $ lc -t       // Full text command to get a question today
-  $ lc 1314     // Get the question by identity
-  $ lc -i 1314  // Full text command to get the  question by identity
-  $ lc -r       // Get a question randomly
+  # Command with no parameters
+  $ lc          // Get a question for today.
+  $ lc 1314     // Get a question by its identity.
+  # Exclusive commands
+  $ lc -t       // Full text command to get a question for today.
+  $ lc -i 1314  // Full text command to get a question by its identity.
+  $ lc -r       // Get a question randomly.
+  # Other instructions
+  $ lc -e       // Easy mode to create a question.
+  $ lc -d src   // Use the relative path to the source folder.
+  $ lc -u       // Check the version to determine whether to update to the latest one.
+  $ lc -v       // Check the CLI version.
+  $ lc -h       // Check the help information.
+  
+`;
 
-`
+export const lkExamples = `
+Examples:
+  # Command with no parameters
+  $ lk          // Check today's question.
+  $ lk 1314     // Check the question by its ID.
+  # Exclusive commands
+  $ lk -t       // Full text command to check today's question.
+  $ lk -i 1314  // Full text command to check the question by its ID.
+  $ lk -r       // Check a randomly generated question.
+  # Other instructions
+  $ lk -e       // Easy mode to check a question.
+  $ lk -d src   // Use the relative path to the source folder.
+  $ lk -u       // Check the version to determine whether to update to the latest one.
+  $ lk -v       // Check the CLI version.
+  $ lk -h       // Display the help information.
+  
+`;
+
+export const lfExamples = `
+Examples:
+  # Command with no parameters
+
+  # Exclusive commands
+
+  # Other instructions
+  $ lf -e       // Easy mode to check a question.
+  $ lf -d src   // Use the relative path to the source folder.
+  $ lf -u       // Check the version to determine whether to update to the latest one.
+  $ lf -v       // Check the CLI version.
+  $ lf -h       // Display the help information.
+  
+`;