mirror of
https://github.com/gizak/termui.git
synced 2025-04-24 13:48:50 +08:00
63 lines
1.4 KiB
ReStructuredText
63 lines
1.4 KiB
ReStructuredText
.. termui documentation master file, created by
|
|
sphinx-quickstart on Thu Nov 17 04:15:50 2016.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. pages:
|
|
- Home: 'index.md'
|
|
- Quickstart: 'quickstart.md'
|
|
- Recipes: 'recipes.md'
|
|
- References:
|
|
- Layouts: 'layouts.md'
|
|
- Components: 'components.md'
|
|
- Events: 'events.md'
|
|
- Themes: 'themes.md'
|
|
- Versions: 'versions.md'
|
|
- About: 'about.md'
|
|
|
|
Welcome to termui's documentation!
|
|
==================================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
quickstart
|
|
init_close
|
|
components
|
|
layouts
|
|
themes
|
|
versions
|
|
recipes
|
|
about
|
|
|
|
`termui <https://github.com/gizak/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:
|
|
|
|
.. figure:: img/dashboard.gif
|
|
:alt: dashboard
|
|
|
|
dashboard
|
|
|
|
*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>`__ is the way to go for starters and
|
|
`Recipes <recipes>`__ contains some practical resolutions you might
|
|
need.
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|