From 655c0aba37942f9edea28a8ba367ddf1a340bd43 Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sat, 23 Feb 2019 23:52:30 -0500 Subject: [PATCH] Updated Home (markdown) --- Home.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/Home.md b/Home.md index b091f1f..2c0eb47 100644 --- a/Home.md +++ b/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. \ No newline at end of file