display

0 # display

1

2 Simple TUI library

3

4 ## Description

5

6 This project is my latest attempt to create a modular end extensible TUI

7 library that takes care of the positioning of the elements on the screen and

8 their nesting.

9

10 As of know it has all of the necessary features for me to start building some

11 staff with it, and figure out the rest as I go.

12

13 ## Dependencies

14

15 * CMake 3.14 or latter

16 * Compiler with C++20 support (tested on clang version 19.1.7)

17 * [`Stamen 1.3.0`](https://github.com/DimitrijeDobrota/stamen) (for running examples)

18

19

20 ## Building and installing

21

22 See the [`BUILDING`](BUILDING.md) document.

23

24

25 ## Usage

26

27 > Please reference example folder for relevant usage examples.

28

29 The library provides the following classes:

30 * `Element`: Base class that takes care of the absolute positioning

31 * `Display`: Main entry point to the terminal screen

32 * `Layout`: Container for one element

33 * `LayoutMulti`: Container for multiple elements

34 * `LayoutRigid`: Divide a screen into custom rectangles

35 * `Window`: Bass class for drawing to the screen

36 * `WindowPivot`: Window that can be placed in the corners or center of the layout

37

38

39 ## Version History

40

41 * 0.2

42 * Proof of concept class hierarchy

43 * Chained rendering and input propagation

44 * Responsive redrawing

45

46 * 0.1

47 * Initial development phase

48

49

50 ## Contributing

51

52 See the [`CONTRIBUTING`](CONTRIBUTING.md) document.

53

54

55 ## License

56

57 This project is licensed under the MIT License - see the [`LICENSE`](LICENSE.md) file for details

58