Skip to content

Commit

Permalink
📃 docs(readme): update/refine readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chen-qingyu committed Apr 28, 2024
1 parent 1c6fa58 commit dbb5e5b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
7 changes: 3 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@ _A C++ type library that is as easy to use as Python built-in types._
### 2. Feature

- Simple: Stay simple, stay young. While ensuring usability and robustness, try to be concise and easy to maintain and read.
- Friendly: Provides many convenient functions. For example, Str class provides replace, split, find and other operations like Python's str, and List class and Str class both support negative index like Python.
- Robust: A secure expansion mechanism to prevent overflow. There are corresponding checks for the addition, deletion, modification, and inspection of containers. Checking will have an impact on performance, but this library is not pursuing performance, but simplicity, usability, and robustness.
- Elegance: With my careful design, it can be used as conveniently as Python's built-in types. Very Pythonic.
- Efficiency: Performance comparison was conducted on the parts that overlap with the standard library, and the [benchmark results](./tests/benchmark.cpp) showed that the performance almost as good as the standard library.
- Friendly: With my careful design, it can be used as conveniently as Python's built-in types. Very Pythonic.
- Robust: There are corresponding checks for the addition, deletion, modification, and inspection of containers.
- Efficiency: The [benchmark results](./tests/benchmark.cpp) show that the performance of the parts with the same function as the STL is almost the same.

### 3. Usage

Expand Down
7 changes: 3 additions & 4 deletions readme_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@ _像 Python 的内置类型一样好用的 C++ 库_
### 2. 特点

- 简洁:Stay simple, stay young. 在保证好用和健壮的前提下,尽量简洁,便于维护和阅读。
- 好用:提供了许多方便的函数,比如 Str 类提供了像 Python 的 str 那样的替换、分割、查找等操作,比如 List 类和 Str 类都支持像 Python 那样的负数索引等等。
- 健壮:安全的扩容机制,防止溢出。对容器的增删改查都有相应的检查。检查会对性能有影响,但是这个库追求的并不是性能,而是简洁,好用和健壮。
- 优雅:经过我的精心设计,用起来可以像 Python 的内置类型一样方便。很 Pythonic。
- 高效:和标准库重合的部分进行了性能比较,[基准测试结果](./tests/benchmark.cpp)表明性能几乎与标准库一样好。
- 好用:经过我的精心设计,用起来可以像 Python 的内置类型一样方便。很 Pythonic。
- 健壮:对容器的增删改查都有相应的检查。
- 高效:[基准测试结果](./tests/benchmark.cpp)表明功能与 STL 相同的部分的性能几乎一样。

### 3. 用法

Expand Down

0 comments on commit dbb5e5b

Please sign in to comment.