You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
37
37
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`.
38
38
39
39
**Building and Running all Packages**
@@ -49,8 +49,7 @@ This will build and run every tests.
49
49
```
50
50
51
51
**Local integration testing**
52
-
53
-
Lets assume you have the following folder structure:
52
+
Let's assume you have the following folder structure:
54
53
- reactor-cpp/
55
54
- lingua-franca/
56
55
- build/your_lfc_build.tar.gz folder that contains your local build of lfc
@@ -84,15 +83,15 @@ Analyse your benchmark for cache misses.
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)
Copy file name to clipboardExpand all lines: README.md
+5-16
Original file line number
Diff line number
Diff line change
@@ -23,16 +23,10 @@ make
23
23
```
24
24
25
25
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.
32
27
33
28
## 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.
36
30
37
31
## Contributing
38
32
@@ -45,11 +39,7 @@ available [online](https://lf-lang.github.io/reactor-cpp/index.html). For tests
45
39
and other purposes, you can also build the documentation locally.
46
40
47
41
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
53
43
are set up, run
54
44
```sh
55
45
pip3 --user install -r doc/requirements.txt
@@ -64,10 +54,9 @@ Now we can build the documentation with:
64
54
make html
65
55
```
66
56
67
-
This will output the project documentaion in `doc/build/html`.
57
+
This will output the project documentation in `doc`/build/html`.
68
58
69
59
## Publications
70
60
71
61
***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