Skip to content

Commit 13cb7d6

Browse files
committed
Update docs.
修改: ChangeLog 修改: README.md 修改: doc/doc.md 修改: doc/platforms.md
1 parent a1e993b commit 13cb7d6

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

ChangeLog

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
2023-08-09 ChenPi11 <wushengwuxi-msctinoulk@outlook.com>
22

33
Add C++ Plus package infomation.
4+
Update docs.
45

56
2023-08-08 ChenPi11 <wushengwuxi-msctinoulk@outlook.com>
67

@@ -14,6 +15,7 @@
1415
Change project structure.
1516
Remove Autoconf buildsystem support.
1617
Add ChangeLog.
18+
Rename the project to 'cppp-platform'.
1719

1820
2023-06-01 ChenPi11 <wushengwuxi-msctinoulk@outlook.com>
1921

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Introduction
22
cppp-platform is a portable platform check library for C++ Plus.
3-
## Build
43

5-
### Dependence
4+
# Build
5+
## Dependence
66
+ CMake (version >= 3.12)
7-
### Make
7+
8+
## Command
89
```shell
910
mkdir build
1011
cd build
@@ -13,7 +14,7 @@ cmake --build .
1314
cmake --install .
1415
```
1516

16-
## Usage
17+
# Example
1718
After install, you can use cppp-platform in C/C++
1819
```c
1920
#include <cppp/cppp-platform.h>
@@ -34,5 +35,5 @@ int main()
3435
}
3536
```
3637

37-
## Manual
38+
# Manual
3839
[User Manual](doc/doc.md)

doc/doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Libplatform User Manual
1+
# cppp-platform Manual
22
[Architectures](./architectures.md)
33

44
[Compilers](./compilers.md)

doc/platforms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The 'xxx' here refers to the OS name, and details can be found in the 'src/platf
1212
**Note: An compile environment may contain multiple environments**
1313
#### Usage
1414
```c
15-
#include <cppp/libplatform.h>
15+
#include <cppp/cppp-platform.h>
1616
#if __has_windows__
1717
#error "We do not support Windows!"
1818
#endif

0 commit comments

Comments
 (0)