Skip to content

Commit 4a331ae

Browse files
authored
Grammar
1 parent ed48d6a commit 4a331ae

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# MicroRNG Software Kit
22

3-
[MicroRNG](https://tectrolabs.com/microrng/) is a hardware (true) random number generator device that can be used in embedded systems as a reliable entropy source. It can interface with microcontrollers or microprocessors (mainboards) with integrated circuits and modules through a mikroBUS™ socket using SPI or 2-wire UART interface and can generate random numbers at a rate up to 1 Mbps in SPI mode and up to 1.5 Mbps in UART mode.
3+
[MicroRNG](https://tectrolabs.com/microrng/) is a hardware (true) random number generator device that can be used in embedded systems as a reliable entropy source. It can interface with microcontrollers or microprocessors (mainboards) with integrated circuits and modules through a mikroBUS™ socket using SPI or 2-wire UART interfaces. It can generate random numbers at a rate up to 1 Mbps in SPI mode and up to 1.5 Mbps in UART mode.
44

5-
This repository contains the MicroRNG Software Kit and utilities for using the MicroRNG device with Raspberry PI 3+ or other Linux-based single-board computers via the SPI interface.
5+
This repository contains the MicroRNG Software Kit and utilities for using the MicroRNG device with Raspberry Pi 3+ or other Linux-based single-board computers via an SPI interface.
66

77
* [More about MicroRNG](https://tectrolabs.com/microrng/)
88

99
## Contents
1010

11-
* `MicroRngSPI.cpp` - API source code in C++ for communicating with the MicroRNG device over SPI interface.
12-
* `mcdiag.cpp` - general purpose diagnostics utility that interacts with the MicroRNG device for determining the maximum clock speed and for validating the communication over SPI interface.
13-
* `mcrng.cpp` - utility for downloading random bytes generated by MicroRNG device over SPI interface.
14-
* `sample.cpp` - sample C++ program that demonstrates how to use the API for communicating with the MicroRNG device over SPI interface.
11+
* `MicroRngSPI.cpp` - API source code in C++ for communicating with a MicroRNG device over an SPI interface.
12+
* `mcdiag.cpp` - general purpose diagnostics utility that interacts with the MicroRNG device for determining the maximum clock speed and for validating the communication over an SPI interface.
13+
* `mcrng.cpp` - utility for downloading random bytes generated by MicroRNG device over an SPI interface.
14+
* `sample.cpp` - sample C++ program that demonstrates how to use the API for communicating with the MicroRNG device over an SPI interface.
1515

1616
## Getting Started
1717

18-
To build and run MicroRNG utilities you will need a sudo access permissions to your Linux instance and an Internet connection.
18+
To build and run the MicroRNG utilities you will need sudo access permissions on your Linux instance.
1919

2020
### Dependencies
2121

@@ -25,17 +25,17 @@ The following dependencies are required to successfully build utilities:
2525
* git
2626
* make
2727

28-
C++ compiler can be installed on Ubuntu with the following command:
28+
The C++ compiler can be installed on Ubuntu with the following command:
2929
```
3030
sudo apt-get install g++
3131
```
3232

33-
Git development dependency can be installed on Ubuntu with the following command:
33+
The git development dependency can be installed on Ubuntu with the following command:
3434
```
3535
sudo apt-get install git
3636
```
3737

38-
Make development dependency can be installed on Ubuntu with the following command:
38+
The make development dependency can be installed on Ubuntu with the following command:
3939
```
4040
sudo apt-get install make
4141
```
@@ -47,7 +47,7 @@ sudo apt-get install make
4747
git clone https://github.com/tectrolabs/microrng.git
4848
```
4949

50-
* Building utilities:
50+
* Build the utilities:
5151
```
5252
cd microrng/mcrng
5353
make
@@ -56,9 +56,9 @@ make
5656
```
5757
sudo make install
5858
```
59-
### Verify MicroRNG is working
59+
### Verify the MicroRNG is working
6060

61-
* Connect MicroRNG device to the target board through provided SPI interface.
61+
* Connect MicroRNG device to the target board through the provided SPI interface.
6262
* Verify device connectivity with the following command (you may need to use a target board sepecific device path):
6363
```
6464
sudo mcdiag /dev/spidev0.0

0 commit comments

Comments
 (0)