Skip to content

Commit a6ab4c4

Browse files
committed
Refine the README.md
Update the command to obtain the tools in Ubuntu. (doxygen and graphviz) Added the git command to obtain this project and sample project.
1 parent e11df74 commit a6ab4c4

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,20 @@ These classes are provided in this version.
2121

2222
The newest copy of this project is found in the [GitHub repository](https://github.com/suikan4github/rpp_driver).
2323

24+
Run the following command to obtain this project from CLI:
25+
```sh
26+
git clone --recursive https://github.com/suikan4github/rpp_driver.git
27+
```
28+
2429
## How to obtain the sample programs
2530

2631
The newest copy of the sample program project is found in the [GitHub repository](https://github.com/suikan4github/rpp_driver-sample).
2732

33+
Run the following command to obtain the sample from CLI:
34+
```sh
35+
git clone --recursive https://github.com/suikan4github/rpp_driver-sample.git
36+
```
37+
2838
## Sample codes
2939
You can obtain sample applications from [rpp-driver_sample](https://github.com/suikan4github/rpp_driver-sample) repository.
3040

@@ -38,10 +48,11 @@ The installation of Ubuntu is :
3848
apt-get -y update
3949
apt-get -y install build-essential cmake ninja-build git doxygen
4050
apt-get -y install gcc-arm-none-eabi libnewlib-arm-none-eabi
51+
apt-get -y install doxygen graphviz
4152
```
4253

43-
## Building tests
44-
The sample program and I2S drivers are tested by GoogleTest and fff. Follow the procedure to build the test.
54+
## Building the tests
55+
The driver classes are tested by GoogleTest and fff. Follow the procedure to build the tests.
4556

4657
From the repository root ( where this README.md stays), run the following commands.
4758
```sh
@@ -52,13 +63,16 @@ cmake --build build --config Debug --target all
5263

5364
## Building document
5465
An API document are provided by HTML files.
55-
To obtain it, run doxygen at the project root ( where this README.md exists).
66+
To obtain it, run doxygen at the project root ( where the README.md exists).
5667

5768
```sh
5869
doxygen
5970
```
6071

61-
The documentation will be generated under html subdirectory.
72+
The documentation will be generated under the docs/html/ subdirectory.
6273

6374
# License
64-
This project is provided under [MIT License](LICENSE).
75+
This project is provided under [MIT License](LICENSE).
76+
77+
# Copyright
78+
@author Seiichi Horie

0 commit comments

Comments
 (0)