Skip to content

Commit 56edf85

Browse files
committed
Refine the README.md.
1 parent dda6433 commit 56edf85

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Raspberry Pi Pico driver class collection
22
A Collection of the Raspberry Pi [Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/)/[Pico2](https://www.raspberrypi.com/products/raspberry-pi-pico-2/) classes. Also, a [SDK API](https://www.raspberrypi.com/documentation/pico-sdk/hardware.html#group_sm_config_1gaed7a6e7dc4f1979c7c62e4773df8c79b) wrapper class is provided.
33

4-
An online [HTML documentation](https://suikan4github.github.io/rpp_driver/) is available for the details.
4+
An online [HTML documentation](https://suikan4github.github.io/rpp_driver/) is available for the details of the APIs.
55

66
# Details
7-
This class collection ( or class library ) encapsule the certain data inside class. And it also allows you to use the dependency-injection inside your project. So, you can test your code with [Google Test](https://github.com/google/googletest) before testing on the target hardware.
7+
This class collection ( or class library ) encapsules the certain data structure of Pico SDK behind the classes. And it also allows programmers to use the dependency-injection in their projects. So, programmers can test their code with [Google Test](https://github.com/google/googletest) before testing on the target hardware.
88

9-
These classes are provided in this version.
9+
The following classes are provided in this version.
1010

1111
| Class | Header file | Description |
1212
|---------------------------------|---- |----------------------------- |
@@ -29,7 +29,7 @@ git clone --recursive https://github.com/suikan4github/rpp_driver.git
2929

3030
## How to obtain the sample programs
3131

32-
The newest copy of the sample program project is found in the [GitHub repository](https://github.com/suikan4github/rpp_driver-sample).
32+
The newest copy of the sample programs are found in the [GitHub repository](https://github.com/suikan4github/rpp_driver-sample).
3333

3434
Run the following command to obtain the sample from CLI:
3535
```sh
@@ -39,8 +39,8 @@ git clone --recursive https://github.com/suikan4github/rpp_driver-sample.git
3939

4040
# Tools and building
4141
## How to install the tools
42-
To build the samples and/or test, you need to install the build tools.
43-
The installation of Ubuntu is :
42+
To build the sample program and/or test program, you need to install the build tools.
43+
The followings are the command to install these tools on Ubuntu.
4444

4545
```sh
4646
apt-get -y update

0 commit comments

Comments
 (0)