updated readme

This commit is contained in:
Chu'vok
2024-09-15 15:15:47 +02:00
parent d8603bfb00
commit 313dc26fcc
2 changed files with 39 additions and 8 deletions

View File

@@ -10,5 +10,6 @@ int main(void) { //
if (is_key_press('q')) // ctrl-c is masked if (is_key_press('q')) // ctrl-c is masked
return 0; // exit on 'q' press return 0; // exit on 'q' press
} // } //
} // } // atexit cleanup
} // automatic cleanup }

40
readme
View File

@@ -1,6 +1,6 @@
* about ********************************************************************** * about **********************************************************************
tim.h is an immediate mode toolkit for creating simple terminal guis tim.h is a portable library to create simple terminal applications
* quick start **************************************************************** * quick start ****************************************************************
@@ -16,8 +16,8 @@ int main(void) { //
if (is_key_press('q')) // ctrl-c is masked if (is_key_press('q')) // ctrl-c is masked
return 0; // exit on 'q' press return 0; // exit on 'q' press
} // } //
} // atexit cleanup
} // } //
} // automatic cleanup
* layout ********************************************************************* * layout *********************************************************************
@@ -26,12 +26,14 @@ the origin is in the top left corner.
Scopes are the primary layout mechanism. They are used to group and place Scopes are the primary layout mechanism. They are used to group and place
multiple elements. Scopes can be nested. multiple elements. Scopes can be nested.
The root scope is the full terminal screen. The scope macro is constructed The root scope is the full terminal screen. The scope macro is constructed
with a for loop, so statements like break or return inside the scope block with a for loop, so statements like break or return inside the scope block
will probably give you a bad time. will probably give you a bad time.
Most elements take x/y/w/h arguments to control placement. All positions are Elements (widget, control, component) are elements of user interaction, such
given in relation the element's parent scope. as a button or edit box. Most elements take x/y/w/h arguments to control
placement. All positions are given in relation the element's parent scope.
Automatic (A) width and height are either based on the element's content, or Automatic (A) width and height are either based on the element's content, or
take the full available space from parent. take the full available space from parent.
@@ -51,6 +53,8 @@ take the full available space from parent.
h | ~n | fit height n rows to bottom h | ~n | fit height n rows to bottom
h | A | automatic height h | A | automatic height
The layout automatically adopts to terminal window resize events.
* colors ********************************************************************* * colors *********************************************************************
Most elements have a uint64 color argument which holds up to eight colors. Most elements have a uint64 color argument which holds up to eight colors.
@@ -70,10 +74,12 @@ https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg
tim_run blocks until it observes an event. Mouse and key events are always tim_run blocks until it observes an event. Mouse and key events are always
immediately followed by a draw event in order to make changes visible. immediately followed by a draw event in order to make changes visible.
The event is stored in tim.event.
Some elements need to consume events, for example edit consumes the key Some elements need to consume events, for example edit consumes the key
event when focused in order to prevent other key handlers on acting on them. event when focused in order to prevent other key handlers on acting on them.
The current event is stored in tim.event.
event | cause event | cause
-------------|----------------------- -------------|-----------------------
DRAW_EVENT | input, timeout, resize DRAW_EVENT | input, timeout, resize
@@ -186,3 +192,27 @@ https://learn.microsoft.com/en-us/windows/console/
- Zero width code points are not supported - Zero width code points are not supported
- Windows cmd.exe resize events may be delayed - Windows cmd.exe resize events may be delayed
* license ********************************************************************
MIT License
Copyright (c) MMXXIV Chu'vok <chuvok@maeppi.e4ward.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
The software is provided "as is", without warranty of any kind, express or
implied, including but not limited to the warranties of merchantability,
fitness for a particular purpose and noninfringement. In no event shall the
authors or copyright holders be liable for any claim, damages or other
liability, whether in an action of contract, tort or otherwise, arising from,
out of or in connection with the software or the use or other dealings in the
software.