README update, main.cpp fix
This commit is contained in:
parent
b30c6e2e73
commit
7013033abd
27
README.md
27
README.md
@ -9,7 +9,7 @@ and can be done on a host machine (e.g. laptop).
|
|||||||
|
|
||||||
# Requirements
|
# Requirements
|
||||||
|
|
||||||
For you own sanity, I really recommend doing this in an Unix environment. If you do not have
|
I really recommend doing this in an Unix environment. If you do not have
|
||||||
or do not want to use a VM, consider using [Ubuntu WSL](https://ubuntu.com/wsl) on Windows.
|
or do not want to use a VM, consider using [Ubuntu WSL](https://ubuntu.com/wsl) on Windows.
|
||||||
|
|
||||||
1. [`git`](https://git-scm.com/) installed
|
1. [`git`](https://git-scm.com/) installed
|
||||||
@ -52,12 +52,27 @@ It is recommended to have a basic understanding of C++ basics and object-oriente
|
|||||||
in general before doing this workshop. There are various books and online resources available to
|
in general before doing this workshop. There are various books and online resources available to
|
||||||
learn this.
|
learn this.
|
||||||
|
|
||||||
|
In general, it is recommended to start with the `ws-tasks` workshop and then move to the
|
||||||
|
`ws-objects` workshop.
|
||||||
|
|
||||||
## Tasks workshop
|
## Tasks workshop
|
||||||
|
|
||||||
This chapter provides an introduction into the thread/tasks abstractions provided by the framework.
|
This chapter provides an introduction into the thread/tasks abstractions provided by the framework.
|
||||||
The chapter descriptions and solutions are located inside `ws-tasks`.
|
The chapter descriptions and solutions are located inside `ws-tasks`.
|
||||||
|
|
||||||
## Structuring your project and managing third-party dependencies with CMake
|
## Object Manager and TMTC handling workshop
|
||||||
|
|
||||||
|
This chapter will introduce the object manager and expand the knowledge of the tasks workshop
|
||||||
|
by showing how to conveniently create global addressable objects. The chapter description and
|
||||||
|
solutions are located inside `ws-objects`.
|
||||||
|
|
||||||
|
## WIP: TMTC workshop
|
||||||
|
|
||||||
|
Provides an introduction into TMTC handling, as virtually all space systems are remote systems
|
||||||
|
where telemetry and telecommands are the primary data interface available to communicate with the
|
||||||
|
satellite.
|
||||||
|
|
||||||
|
## WIP: Structuring your project and managing third-party dependencies with CMake
|
||||||
|
|
||||||
OBSW usually becomes very complex as more and more features and functionality is added.
|
OBSW usually becomes very complex as more and more features and functionality is added.
|
||||||
We need to split the software into smaller dedicated modules as this happens to keep complexity
|
We need to split the software into smaller dedicated modules as this happens to keep complexity
|
||||||
@ -67,14 +82,8 @@ in C/C++ with no built-in package management and an archaic header system. This
|
|||||||
will attempt to alleviate some of the pain by showing how to integrate a CMake compatible library
|
will attempt to alleviate some of the pain by showing how to integrate a CMake compatible library
|
||||||
by example and how to intgerate a library without CMake support.
|
by example and how to intgerate a library without CMake support.
|
||||||
|
|
||||||
## Object Manager and TMTC handling workshop
|
|
||||||
|
|
||||||
This chapter will introduce the object manager and expand the knowledge of the tasks workshop
|
## WIP: Controller workshop
|
||||||
by showing how to conveniently create global addressable objects. It also provides an
|
|
||||||
introduction into TMTC handling, as virtually all space systems are remote systems where
|
|
||||||
telemetry and telecommands are the primary data interface available to communicate with the satellite.
|
|
||||||
|
|
||||||
## Controller workshop
|
|
||||||
|
|
||||||
This chapter will introduce the `ControllerBase` and `ExtendedControllerBase` class
|
This chapter will introduce the `ControllerBase` and `ExtendedControllerBase` class
|
||||||
and the various helper interfaces they expose.
|
and the various helper interfaces they expose.
|
||||||
|
Loading…
Reference in New Issue
Block a user