Add global readme

This commit is contained in:
Simon Bruder 2023-04-22 14:54:47 +02:00
parent 403c143ea3
commit 1cf9cf7a16

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# Programming tasks for ECG
This repository includes my solutions to the tasks
for the module [*Einführung in die Computergraphik* (Introduction to computer graphics)](https://tu-dresden.de/ing/informatik/smt/cgv/studium/lehrveranstaltungen/ss2023/ecg)
in the summer semester 2023 at the [TU Dresden](https://tu-dresden.de/).
Each exercise includes a separate `readme.txt`
that describes things specific to how I implemented the task.
However, those documents are in German, which is a requirement.
## Usage
### Build
To build a specific exercise,
you can use [Nix](https://nixos.org/) with flake support:
```bash
nix build -L .#u01
```
You can also manually invoke CMake.
This requires you to have all dependencies installed.
Because this is not my preferred way, there is no canonical list of dependencies,
but you can find them in `flake.nix`.
### Development
You can use `nix develop` or [`direnv`](https://direnv.net/).
## Licence
[GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html).
See [COPYING](./COPYING) and [gpl-3.0.txt](./gpl-3.0.txt) for details.