termui/_docs/index.md

16 lines
571 B
Markdown

[termui]() is a cross-platform, easy-to-compile, and fully-customizable terminal dashboard. It aims to provide a terminal front end for your applications with less struggle:
> ![dashboard](img/dashboard.gif)
>
> _cast under osx 10.10; Terminal.app; Menlo Regular 12pt._
This guide describes the essential parts used to build a interface, which includes:
- Installation & Usage
- Layout System
- Event System
- Theming
- Components
[Quickstart](quickstart.md) is the way to go for starters and [Recipes](recipes.md) contains some practical resolutions you might need.