Skip to content

Commit 0371eb8

Browse files
author
Michael Lee
committed
fix issue #2: classify examples
1 parent 92c94be commit 0371eb8

File tree

2 files changed

+38
-24
lines changed

2 files changed

+38
-24
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1-
- [About](#org0eece13)
2-
- [Benchmark](#orgb0788de)
3-
- [Examples](#orgcee2ec3)
4-
- [Multiple languages](#orgc38d3b6)
5-
- [English, Ukrainian, Greek, etc.](#org3471bf1)
6-
- [Chinese, Japanese, Thai, etc.](#org9866902)
7-
- [Append/prepend](#org3300cd3)
8-
- [Indentation](#orgca55d32)
9-
- [Trailing notation](#orgb07406f)
10-
- [License](#org0e4bb09)
1+
- [About](#org71c9f44)
2+
- [Benchmark](#org0e2097f)
3+
- [Features](#orgf7c3364)
4+
- [Examples(`use_std` feature)](#org9a24038)
5+
- [Multiple languages](#org4780be6)
6+
- [English, Ukrainian, Greek, etc.](#org0e9b0e8)
7+
- [Chinese, Japanese, Thai, etc.](#org3478d81)
8+
- [Append/prepend](#org18aca0f)
9+
- [Indentation](#org500ef41)
10+
- [Trailing notation](#org1fd42b9)
11+
- [License](#org4c63b79)
1112

1213

1314

14-
<a id="org0eece13"></a>
15+
<a id="org71c9f44"></a>
1516

1617
# About
1718

@@ -24,7 +25,7 @@ Bwrap is a fast, lightweight, embedded environment-friendly library for wrapping
2425
For the sake of readability, we (**b**)etter **wrap** our text.
2526

2627

27-
<a id="orgb0788de"></a>
28+
<a id="org0e2097f"></a>
2829

2930
# Benchmark
3031

@@ -45,19 +46,26 @@ Note:
4546
2. The data above is recorded on an i5-3337u/12G machine and is for reference only. It is possible to have a slightly different result on a different machine or with different idle system resource.
4647

4748

48-
<a id="orgcee2ec3"></a>
49+
<a id="orgf7c3364"></a>
4950

50-
# Examples
51+
# Features
5152

53+
`use_std`: Use Rust standard library(libstd) for automatic memory management.
5254

53-
<a id="orgc38d3b6"></a>
55+
56+
<a id="org9a24038"></a>
57+
58+
# Examples(`use_std` feature)
59+
60+
61+
<a id="org4780be6"></a>
5462

5563
## Multiple languages
5664

5765
Bwrap suuport multiple languages, it categorizes languages into two categories: **space-sensitive** and **space-insensitive**. The former is for the languages that depend on ASCII SPACE to delimit words, such as English, Ukrainian, Greek and so on. The latter is for the languages that are space-insensitive, such as Chinese, Japanese, Thai and so on.
5866

5967

60-
<a id="org3471bf1"></a>
68+
<a id="org0e9b0e8"></a>
6169

6270
### English, Ukrainian, Greek, etc.
6371

@@ -134,7 +142,7 @@ Bwrap suuport multiple languages, it categorizes languages into two categories:
134142
```
135143
136144
137-
<a id="org9866902"></a>
145+
<a id="org3478d81"></a>
138146
139147
### Chinese, Japanese, Thai, etc.
140148
@@ -211,14 +219,14 @@ Bwrap suuport multiple languages, it categorizes languages into two categories:
211219
```
212220
213221
214-
<a id="org3300cd3"></a>
222+
<a id="org18aca0f"></a>
215223
216224
## Append/prepend
217225
218226
Bwrap can append or prepend whatever string to newly added newline character. With this feature, one can effectively achieve indentation, line trailing notation or similar.
219227
220228
221-
<a id="orgca55d32"></a>
229+
<a id="org500ef41"></a>
222230
223231
### Indentation
224232
@@ -253,7 +261,7 @@ println!("WRAPPED:\n\n{}", wrapped);
253261
```
254262

255263

256-
<a id="orgb07406f"></a>
264+
<a id="org1fd42b9"></a>
257265

258266
### Trailing notation
259267

@@ -288,8 +296,8 @@ println!("WRAPPED:\n\n{}", wrapped);
288296
```
289297

290298

291-
<a id="org0e4bb09"></a>
299+
<a id="org4c63b79"></a>
292300

293301
# License
294302

295-
Bwrap can be licensed under either [MIT License](https://github.com/imichael2e2/bwrap/blob/master/LICENSE-MIT) or [GNU General Public License Version 3.0](https://github.com/imichael2e2/bwrap/blob/master/LICENSE-GPL). The choice is up to the recipient.
303+
Bwrap can be licensed under either [MIT License](https://github.com/imichael2e2/bwrap/blob/master/LICENSE-MIT) or [GNU General Public License Version 3.0](https://github.com/imichael2e2/bwrap/blob/master/LICENSE-GPL). The choice is up to the recipient.

README.org

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,12 @@ Note:
4040
system resource.
4141

4242

43-
* Examples
43+
* Features
44+
45+
=use_std=: Use Rust standard library(libstd) for automatic memory
46+
management.
47+
48+
* Examples(=use_std= feature)
4449

4550
** Multiple languages
4651

@@ -177,7 +182,7 @@ Source code:
177182
#+begin_src rust
178183
let line = "ありがとうございますありがとうございますありがとうございます";
179184
println!("ORIGINAL:\n\n{}\n", line);
180-
println!("WRAPPED:\n\n{}", bwrap::wrap_maybrk!(line, 10));
185+
println!("WRAPPED:\n\n{}", bwrap::wrap_maybrk!(line, 20));
181186
#+end_src
182187

183188

@@ -283,3 +288,4 @@ println!("WRAPPED:\n\n{}", wrapped);
283288

284289
Bwrap can be licensed under either [[https://github.com/imichael2e2/bwrap/blob/master/LICENSE-MIT][MIT License]] or [[https://github.com/imichael2e2/bwrap/blob/master/LICENSE-GPL][GNU General
285290
Public License Version 3.0]]. The choice is up to the recipient.
291+

0 commit comments

Comments
 (0)