Skip to content

Commit 2b2ef0c

Browse files
committed
Run spell-checker on docs
1 parent f0f62ad commit 2b2ef0c

File tree

2 files changed

+12
-24
lines changed

2 files changed

+12
-24
lines changed

CONTRIBUTING.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
## Programming Style
66

7-
The project is currently implemented in C++17 and follows primarly the cpp-core-guidlines.
8-
Please make sure you subbmitted code follows the .clang-tidy and .clang-format file.
7+
The project is currently implemented in C++17 and follows primarily the [C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
8+
Please make sure your submitted code follows the .clang-tidy and .clang-format files.
99

1010
### Testing
11-
There are CI Tests which automatically check your code. If you want to perform the tests manually take a look
11+
There are CI Tests that automatically check your code. If you want to perform the tests manually take a look
1212
at this [guide](https://github.com/lf-lang/lingua-franca/wiki/Regression-Tests).
1313

1414
## Building and Testing with Nix
@@ -33,7 +33,7 @@ at this [guide](https://github.com/lf-lang/lingua-franca/wiki/Regression-Tests).
3333
$ nix build .#packages.x86_64-linux.ActionDelay-gcc-wrapper-10-3-0 --override-input reactor-cpp github:lf-lang/reactor-cpp/<revision - branch>
3434
```
3535

36-
The important thing to note is that the `--override-input` flag can take literally any source. In this example it takes the `cpp-core-guidleines` branch
36+
The important thing to note is that the `--override-input` flag can take literally any source. In this example, it takes the `cpp-core-guidleines` branch
3737
but you maybe also want to use your fork then the argument would look like this `--override-input reactor-cpp github:revol-xut/reactor-cpp`.
3838

3939
**Building and Running all Packages**
@@ -49,8 +49,7 @@ This will build and run every tests.
4949
```
5050

5151
**Local integration testing**
52-
53-
Lets assume you have the following folder structure:
52+
Let's assume you have the following folder structure:
5453
- reactor-cpp/
5554
- lingua-franca/
5655
- build/your_lfc_build.tar.gz folder that contains your local build of lfc
@@ -84,15 +83,15 @@ Analyse your benchmark for cache misses.
8483
```
8584

8685
**Callgrind**
87-
Profile and analyse your benchmarks call chain.
86+
Profile and analyze your benchmarks call chain.
8887
```
8988
nix build .\#packages.x86_64-linux.callgrind-SleepingBarber-gcc-wrapper-10-3-0
9089
```
9190

9291

9392

9493
### Benchmarking
95-
If youre changes are performance critically it is adviced to run the test from [here](https://github.com/lf-lang/lingua-franca/wiki/Running-Benchmarks)
94+
If your changes are performance-critical it is advised to run the test from [here](https://github.com/lf-lang/lingua-franca/wiki/Running-Benchmarks)
9695

9796

9897
## Git

README.md

+5-16
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,10 @@ make
2323
```
2424

2525
The examples need to be built explicitly.
26-
27-
```
28-
make examples
29-
```
30-
31-
Alternatively take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) for building with nix package manager.
26+
Alternatively, take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) for building with nix package manager.
3227

3328
## Extras
34-
35-
reactor-cpp can be build with [tracing support](https://github.com/lf-lang/reactor-cpp/tree/master/tracing). This provides a powerful tool for analyzing and debugging reactor applications.
29+
reactor-cpp can be built with [tracing](https://github.com/lf-lang/reactor-cpp/tree/master/tracing) support](https://github.com/lf-lang/reactor-cpp/tree/master/tracing). This provides a powerful tool for analyzing and debugging reactor applications.
3630

3731
## Contributing
3832

@@ -45,11 +39,7 @@ available [online](https://lf-lang.github.io/reactor-cpp/index.html). For tests
4539
and other purposes, you can also build the documentation locally.
4640

4741
First doxygen needs to be installed. On Ubuntu or Debian, run:
48-
```sh
49-
sudo apt-get install doxygen
50-
```
51-
52-
Further we need several python packages. Assuming that both python3 and pip3
42+
Further, we need several Python packages. Assuming that both python3 and pip3
5343
are set up, run
5444
```sh
5545
pip3 --user install -r doc/requirements.txt
@@ -64,10 +54,9 @@ Now we can build the documentation with:
6454
make html
6555
```
6656

67-
This will output the project documentaion in `doc/build/html`.
57+
This will output the project documentation in `doc`/build/html`.
6858

6959
## Publications
7060

7161
* **DATE'20:** Christian Menard, Andrés Goens, Marten Lohstroh, Jeronimo Castrillon, [Achieving Determinism in Adaptive AUTOSAR](https://arxiv.org/pdf/1912.01367), Proceedings of the 2020 Design, Automation and Test in Europe Conference (DATE), EDA Consortium, Mar 2020.
72-
73-
Also see the Lingua Franca [publications](https://github.com/lf-lang/lingua-franca/wiki/Publications-and-Presentations).
62+
Also, see the Lingua Franca [publications](https://github.com/lf-lang/lingua-franca/wiki/Publications-and-Presentations).

0 commit comments

Comments
 (0)