diff --git a/CMakeLists.txt b/CMakeLists.txt index 7f5dc25..00525c6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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() diff --git a/README.md b/README.md index 08052f1..144fa6a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/README.md b/docs/README.md index abac076..d03f8ac 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -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. \ No newline at end of file +Creating a new solution from scratch is not easy, but it can solve the problems of the exiting ones. diff --git a/docs/guided_examples/2_Ports_and_SimoSim/README.md b/docs/guided_examples/2_Ports_and_SimoSim/README.md index b86b95b..36852ea 100644 --- a/docs/guided_examples/2_Ports_and_SimoSim/README.md +++ b/docs/guided_examples/2_Ports_and_SimoSim/README.md @@ -68,4 +68,4 @@ when Simo is built. To run the example, use the following command: ```bash SimoSim --config /system_config.yaml --search-path -``` \ No newline at end of file +``` diff --git a/docs/guided_examples/4_Nested_Modules/README.md b/docs/guided_examples/4_Nested_Modules/README.md index 5362116..bd496d5 100644 --- a/docs/guided_examples/4_Nested_Modules/README.md +++ b/docs/guided_examples/4_Nested_Modules/README.md @@ -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 @@ -36,4 +36,4 @@ public: NestedModule* nested_module = nullptr; }; -``` \ No newline at end of file +```