Updated Container API (markdown)

Jakub Sobon 2019-03-02 18:40:46 -05:00
parent 547e27f6e2
commit e9d25d0650
1 changed files with 1 additions and 1 deletions

@ -2,7 +2,7 @@
[![Doc Status](https://godoc.org/github.com/mum4k/termdash/container?status.png)](https://godoc.org/github.com/mum4k/termdash/container)
The [container](https://github.com/mum4k/termdash/tree/master/container) package is used to establish and mutate the layout of the terminal. An instance of the container object is required to start the Termdash application, see the [[Termdash API|termdash-api]] for details.
The [container](https://godoc.org/github.com/mum4k/termdash/container) package is used to establish and mutate the layout of the terminal. An instance of the container object is required to start the Termdash application, see the [[Termdash API|termdash-api]] for details.
The container splits the raw terminal into smaller portions (sub-containers). The developer decides how the splits are organized. Design of the container object is heavily inspired by the [i3 window manager](https://i3wm.org/), specifically by how the i3 wm organizes the layout of application windows on the screen.