Skip to content

Commit aed0dd9

Browse files
committed
doc: move to tmpl project
1 parent 25f3539 commit aed0dd9

12 files changed

+58
-368
lines changed

.gitignore

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
2-
.idea
3-
.vscode
1+
2+
.idea
3+
.vscode
4+
.obsidian

README.md

Lines changed: 21 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,28 @@
1-
# LeetCode Local Debugging Environment Configuration (JetBrains)
1+
# LeetCode 配置本地调试环境所需要的库
22

3-
[中文文档](https://github.com/zonewave/leetcode-precompiled/blob/master/README_CN.md)
4-
## Introduction
3+
## 简介
4+
本项目提供本地调试leetcode环境的所需的工具库
55

6-
This project is based on leetcode-editor and provides problem solution templates to facilitate local debugging of LeetCode environments.
6+
如何配置可参考[模板项目](https://github.com/zonewave/leetcode-local-debug-tmpl)
77

8-
## Motivation
9-
Solving problems on the web can be quite painful, especially when encountering complex test cases that fail to pass. It often takes a long time to pinpoint the issues. Therefore, I wanted to use a local IDE for step-by-step debugging of LeetCode problems, as it's generally more convenient and allows for quicker issue identification. I later installed leetcode-editor in PyCharm. However, the default templates were too simplistic, making it cumbersome to write test cases, and I couldn't find good templates online. This led to the creation of this project. With my template, you only need to configure the parameter types, and then you can simply copy the test cases from the problem description to run them. Currently, it only supports Python, but there will be support for other languages in the future.
108

11-
### [Python](https://github.com/zonewave/leetcode-precompiled/blob/master/py/README.md)
12-
![debug](https://github.com/zonewave/leetcode-precompiled/blob/master/py/img/debug.jpg)
9+
## 特性
10+
- 支持多种编程语言的工具包,包含官方声明的所有数据结构,如 `ListNode``NestedInteger``TreeNode`
11+
- 提供部分工具函数,比如数组转链表,数组转树,数组转图的,可以更好地本地测试
1312

14-
## Features
1513

16-
- Supports multiple programming languages with toolkits, including all officially declared data structures such as `ListNode``NestedInteger``TreeNode`, etc.
17-
- Provides some utility functions for better local testing.
18-
- Based on leetcode-editor, offers template content for various programming languages.
19-
- Easy to use, suitable for quickly configuring a local debugging environment for LeetCode problems.
14+
## 支持的编程语言
15+
- [Python](https://github.com/zonewave/leetcode-precompiled/blob/master/py/README_CN.md)
16+
- [Cpp](https://github.com/zonewave/leetcode-local-debug-tmpl)
2017

21-
## Supported Programming Languages
22-
23-
- [x] [Python](./py/README.md)
24-
- [ ] Go
25-
- [ ] Java
26-
- [ ] CSharp
27-
- [ ] C++
28-
- [ ] C
29-
- [ ] Rust
30-
31-
## Contributions
32-
33-
Contributions of any kind are welcome! If you have new data structures or suggestions for improvements, please submit a pull request or raise an issue.
34-
35-
## License
36-
37-
This project is licensed under the MIT License. For more details, please see the [LICENSE](https://github.com/zonewave/leetcode-precompiled/blob/master/LICENSE) file.
38-
39-
## Contact Information
40-
41-
If you have any questions, please contact the project maintainer.
18+
## 贡献
19+
20+
欢迎任何形式的贡献!如果您有新的数据结构或改进建议,请提交拉取请求或提出问题。
21+
22+
## 许可证
23+
24+
本项目采用 MIT 许可证,详细信息请查看 [LICENSE](https://github.com/zonewave/leetcode-precompiled/blob/master/LICENSE) 文件。
25+
26+
## 联系信息
27+
28+
如有疑问,请联系项目维护者。

README_CN.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

cpp/README_CN.md renamed to cpp/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,16 @@
22

33
欢迎使用 Leetcode cpp precompiled 库!
44

5-
65
precompiled
76
本库包含
8-
97
1. leetcode 官方声明的所有数据结构
10-
2. 本地测试所需的各种工具函数 [api说明](#常用数据结构和方法)
11-
12-
// todo
8+
2. 本地测试所需的各种工具函数
139

1410
## 使用说明
1511

1612
### 常用数据结构和方法
17-
// todo
1813
- **ListNode**:链表节点
1914
- **NestedInteger**:嵌套整数
2015
- **TreeNode**:树节点
16+
17+
// todo

py/README.md

Lines changed: 30 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,47 @@
1-
# LeetCode Python Debug in pycharm
1+
# LeetCode Python 预编译库
22

3-
[github](https://github.com/zonewave/leetcode-precompiled)
4-
5-
[中文文档](https://github.com/zonewave/leetcode-precompiled/blob/master/py/README_CN.md)
6-
7-
## How to debug leetcode problem
8-
9-
### install [leetcode-editor](https://github.com/shuzijun/leetcode-editor)
10-
11-
###
12-
13-
![settingimag](https://github.com/zonewave/leetcode-precompiled/blob/master/py/img/templatesetting.jpg)
14-
15-
[template content](https://github.com/zonewave/leetcode-precompiled/blob/master/py/jetbrain_editor_template.md)
16-
17-
### click problem and init python file
3+
欢迎使用 LeetCode Python 工具库!
184

19-
![init](https://github.com/zonewave/leetcode-precompiled/blob/master/py/img/init.jpg)
20-
21-
### replace arg and add test case
22-
23-
![debug](https://github.com/zonewave/leetcode-precompiled/blob/master/py/img/debug.jpg)
24-
25-
## Install tool package
26-
27-
You can install the library using the following commands:
5+
[github](https://github.com/zonewave/leetcode-precompiled)
286

29-
### Using pip
7+
本库包含
8+
1. leetcode 官方声明的所有数据结构
9+
2. 本地测试所需的各种工具函数 [api说明](#常用数据结构和方法)
10+
## 安装
3011

31-
```sh
32-
pip install precompiled
33-
```
3412

35-
### Using pdm
13+
目前稳定版本为0.1.8。
14+
可以通过以下命令安装该库:
15+
### bash
16+
``` sh
17+
pip install precompiled
18+
```
19+
### pdm
3620

37-
```sh
21+
```sh
3822
pdm add precompiled
39-
```
23+
```
4024

41-
## Usage
25+
## 使用说明
4226

43-
Once installed, you can use the following import statements in your Python code to access all data
44-
structures from LeetCode:
27+
安装完成后,您可以在 Python 代码中使用以下导入语句来访问leetcode所有数据结构:
4528

4629
python
4730

48-
```python
31+
复制
32+
33+
```python
4934
from precompiled.listnode import ListNode
5035
from precompiled.nestedinteger import NestedInteger
5136
from precompiled.treenode import TreeNode
37+
```
5238

53-
`
54-
```
55-
56-
### Common Data Structures and Methods
57-
58-
- **ListNode**: Linked list node
59-
- Default implementation of the`eq`method
60-
- `array_to_list_node`: Converts an array into a linked list, returning the head node
61-
- `arrays_to_list_node`: Converts multiple arrays into multiple linked lists, returning a tuple
62-
of linked lists
63-
- `index`: get Returns the idx node of the linked list,
64-
- **NestedInteger**: Nested integer
65-
- **TreeNode**: Tree node
39+
### 常用数据结构和方法
6640

41+
- **ListNode**:链表节点
42+
- 默认实现eq方法
43+
- array_to_list_node 将数组转换成链表,返回头结点
44+
- arrays_to_list_node 将多个数组转成多个链表,返回以链表为元素的元组
45+
- index: 返回链表第 idx 个节点, 下标从 0 开始。
46+
- **NestedInteger**:嵌套整数
47+
- **TreeNode**:树节点

py/README_CN.md

Lines changed: 0 additions & 116 deletions
This file was deleted.

py/img/debug.jpg

-368 KB
Binary file not shown.

py/img/init.jpg

-355 KB
Binary file not shown.

py/img/templatesetting.jpg

-173 KB
Binary file not shown.

py/img/vscode_run.gif

-2.12 MB
Binary file not shown.

0 commit comments

Comments
 (0)