OrgGo
/
termui
mirror of https://github.com/gizak/termui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Zack Guo 2015-02-08 12:07:18 -05:00
parent 74d3a0a37a
commit 8cbb89eb3e
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,11 +1,11 @@
# termui
Go terminal dashboard, inspired by [blessed-contrib](https://github.com/yaronn/blessed-contrib), but purely in Go.
Go terminal dashboard. Inspired by [blessed-contrib](https://github.com/yaronn/blessed-contrib), but purely in Go.
Cross-platform, easy to compile, and fully-customizable.
__Demo:__
<img src="https://github.com/gizak/termui/tree/master/example/screencast.gif" alt="demo" width="800">
<img src="https://raw.githubusercontent.com/gizak/termui/tree/master/example/screencast.gif" alt="demo" width="600">
## Installation
@ -13,7 +13,9 @@ __Demo:__
## Usage
Each component's layout is a bit like HTML block, which has border and padding. The `Border` property can be chosen to hide or display (with its border label), when it comes to display, in this case the space it takes is counted as padding space (i.e. `PaddingTop=PaddingBottom=PaddingLeft=PaddingRight=1`).
Each component's layout is a bit like HTML block, which has border and padding.
The `Border` property can be chosen to hide or display (with its border label), when it comes to display, in this case the space it takes is counted as padding space (i.e. `PaddingTop=PaddingBottom=PaddingLeft=PaddingRight=1`).
`````go
import ui "github.com/gizak/termui" // <- ui shortcut, optional
@ -48,7 +50,7 @@ Each component's layout is a bit like HTML block, which has border and padding.
}
`````
Note that components can be overlapped (I'd rather call this as a feature...), `Render(Renderer...)` renders its args from left to right (i.e. each component's weight is arising from left to right).
Note that components can be overlapped (I'd rather call this as a feature...), `Render(rs ...Renderer)` renders its args from left to right (i.e. each component's weight is arising from left to right).
## Widgets