Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,6 @@ if (ENABLE_DOCUMENTATION)

doxygen_add_docs(
doxygen_docs
include src docs tests "${CMAKE_CURRENT_SOURCE_DIR}/README.md"
include src docs support tests "${CMAKE_CURRENT_SOURCE_DIR}/README.md"
)
endif()
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The GitHub actions run entering the virtual environment of `nix develop`.

## First Steps

Look inside [docs/guided_examples](./docs/guided_examples) .
Look inside [docs/guided_examples](./docs/guided_examples/README.md).

## Features

Expand Down Expand Up @@ -73,7 +73,7 @@ Default compiler is clang. There is support for gcc build as well. With `nix`, u
a development environment that uses gcc as compiler.

### IDEs
You can see [this guide](./support/ides/clion/README.md) on how to use nix
You can see [this guide](./support/ides/clion/README.md) on how to use nix
binaries to build in CLion.

## To Do
Expand Down
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Find the tutorial in [guided_examples folder](./guided_examples)
# Documentation

Find the tutorial in the [guided_examples folder](./guided_examples/README.md).

## Motivations

Expand All @@ -13,4 +15,4 @@ and Python. Countless hours are spent learning (and debugging) before obtaining
Well adopted in industry. It is supposed to work in theory, but in practice it is terrible (learning the library is not
trivial, cannot have proper unit-tests infrastructure).

Creating a new solution from scratch is not easy, but it can solve the problems of the exiting ones.
Creating a new solution from scratch is not easy, but it can solve the problems of the exiting ones.
2 changes: 1 addition & 1 deletion docs/guided_examples/2_Ports_and_SimoSim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ when Simo is built. To run the example, use the following command:

```bash
SimoSim --config <EXAMPLE_PATH>/system_config.yaml --search-path <SIMO_BUILD_PATH>
```
```
4 changes: 2 additions & 2 deletions docs/guided_examples/4_Nested_Modules/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Nested Modules

This document briefly explains how to create modules inside other modules.
[./NestedModules.cc](./NestedModules.cc) is a minimal example.
[NestedModule.cc](./NestedModule.cc) is a minimal example.

## Nested modules

Expand Down Expand Up @@ -36,4 +36,4 @@ public:
NestedModule* nested_module = nullptr;
};

```
```