Updated Home (markdown)

Jakub Sobon 2019-02-23 23:52:30 -05:00
parent 2e45068998
commit 655c0aba37
1 changed files with 30 additions and 0 deletions

30
Home.md

@ -10,11 +10,41 @@ This wiki is the main source of documentation for **users** and **developers* wo
- Release Notes
- Examples
- Tutorials
- Design documentation
- Widgets
## Getting started
Running the Termdash demo is the quickest way to start playing with Termdash. See the following paragraph for instruction on how to install Termdash and run the demo.
To explore more advanced use cases, refer to the Examples, the Tutorials and the API reference.
### Installing
To install Termdash, run the following command:
```
go get -u github.com/mum4k/termdash
```
Next try running the [termdashdemo.go](https://github.com/mum4k/termdash/blob/master/termdashdemo/termdashdemo.go) binary.
```
go run github.com/mum4k/termdash/termdashdemo/termdashdemo.go
```
## Supported Environments
Termdash is a higher level library that relies on libraries that expose a cell view of the terminal. Termdash currently uses [termbox-go](https://github.com/nsf/termbox-go). This means that Termdash supports all the environment that are supported by termbox-go.
### POSIX (Linux, FreeBSD, macOS, Solaris, etc.)
Most mainstream systems with well defined tty interface will work without any issues.
### Windows
Windows applications are supported, e.g. native command prompt or power shell. Unfortunately **mintty** and other **cygwin** style application aren't supported since termbox-go doesn't support them. See this [issue](https://github.com/nsf/termbox-go/issues/66) for details.
## Questions or need help?
See the [[Talk to us|Talk-to-us]] for different ways of getting in touch.