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

18

19 ## Building and installing

20

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

22

23

24 ## Usage

25

26 > Please reference example folder for relevant usage examples.

27

28 The library provides the following classes:

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

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

31 * `Layout`: Container for one element

32 * `LayoutMulti`: Container for multiple elements

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

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

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

36

37

38 ## Version History

39

40 * 0.2

41 * Proof of concept class hierarchy

42 * Chained rendering and input propagation

43 * Responsive redrawing

44

45 * 0.1

46 * Initial development phase

47

48

49 ## Contributing

50

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

52

53

54 ## License

55

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

57