Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run spell-checker on docs #56

Merged
merged 1 commit into from
May 4, 2024
Merged

Run spell-checker on docs #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

## Programming Style

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

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

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

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
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
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`.

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

**Local integration testing**

Lets assume you have the following folder structure:
Let's assume you have the following folder structure:
- reactor-cpp/
- lingua-franca/
- build/your_lfc_build.tar.gz folder that contains your local build of lfc
Expand Down Expand Up @@ -84,15 +83,15 @@ Analyse your benchmark for cache misses.
```

**Callgrind**
Profile and analyse your benchmarks call chain.
Profile and analyze your benchmarks call chain.
```
nix build .\#packages.x86_64-linux.callgrind-SleepingBarber-gcc-wrapper-10-3-0
```



### Benchmarking
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)
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)


## Git
Expand Down
21 changes: 5 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,10 @@ make
```

The examples need to be built explicitly.

```
make examples
```

Alternatively take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) for building with nix package manager.
Alternatively, take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) for building with nix package manager.

## Extras

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.
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.

## Contributing

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

First doxygen needs to be installed. On Ubuntu or Debian, run:
```sh
sudo apt-get install doxygen
```

Further we need several python packages. Assuming that both python3 and pip3
Further, we need several Python packages. Assuming that both python3 and pip3
are set up, run
```sh
pip3 --user install -r doc/requirements.txt
Expand All @@ -64,10 +54,9 @@ Now we can build the documentation with:
make html
```

This will output the project documentaion in `doc/build/html`.
This will output the project documentation in `doc`/build/html`.

## Publications

* **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.

Also see the Lingua Franca [publications](https://github.com/lf-lang/lingua-franca/wiki/Publications-and-Presentations).
Also, see the Lingua Franca [publications](https://github.com/lf-lang/lingua-franca/wiki/Publications-and-Presentations).
Loading