8000 docs: Update the headers in the documentation · ChaiScript/ChaiScript_Extras@94ded81 · GitHub
[go: up one dir, main page]

Skip to content

Commit 94ded81

Browse files
authored
docs: Update the headers in the documentation
1 parent 2aee0d2 commit 94ded81

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# ChaiScript Extras
22

3-
User contributed wrappers for ChaiScript.
3+
User contributed wrappers and modules for ChaiScript.
44

55
## Modules
66

77
- [Math](#math): Adds common math methods to ChaiScript.
88
- [String ID](#string-id): String hashing with [string_id](https://github.com/foonathan/string_id)
9-
- [String Methods](#string-methods): Introduces some extra string methods to ChaiScript strings
9+
- [String](#string): Adds some extra string methods to ChaiScript strings
1010

11-
### Math
11+
## Math
1212
1313
The Math module adds some standard math functions to ChaiScript.
1414

15-
#### Install
15+
### Install
1616
``` cpp
1717
#include "chaiscript/extras/math.hpp"
1818
```
@@ -22,22 +22,22 @@ auto mathlib = chaiscript::extras::math::bootstrap();
2222
chai.add(mathlib);
2323
```
2424

25-
#### Usage
25+
### Usage
2626

2727
``` chaiscript
2828
var result = cos(0.5f)
2929
```
3030

31-
#### Options
31+
### Options
3232

3333
Compile with one of the following flags to enable or disable features...
3434
- `CHAISCRIPT_EXTRAS_MATH_SKIP_ADVANCED` When enabled, will skip some of the advanced math functions.
3535

36-
### String ID
36+
## String ID
3737

3838
Adds [String ID](https://github.com/foonathan/string_id) support to ChaiScript.
3939

40-
#### Install
40+
### Install
4141

4242
``` cpp
4343
#include "chaiscript/extras/string_id.hpp"
@@ -48,7 +48,7 @@ auto string_idlib = chaiscript::extras::string_id::bootstrap();
4848
chai.add(string_idlib);
4949
```
5050

51-
### String Methods
51+
## String
5252

5353
Adds various string methods to extend how strings can be used in ChaiScript:
5454
- `string::replace(string, string)`
@@ -57,7 +57,7 @@ Adds various string methods to extend how strings can be used in ChaiScript:
5757
- `string::toLowerCase()`
5858
- `string::toUpperCase()`
5959

60-
#### Install
60+
### Install
6161

6262
``` cpp
6363
#include "chaiscript/extras/string_methods.hpp"
@@ -68,7 +68,7 @@ auto stringmethods = chaiscript::extras::string_methods::bootstrap();
6868
chai.add(stringmethods);
6969
```
7070

71-
#### Usage
71+
### Usage
7272

7373
``` chaiscript
7474
var input = "Hello, World!"

0 commit comments

Comments
 (0)
0