| skipped 7 lines |
8 | 8 | | |
9 | 9 | | # termdash |
10 | 10 | | |
11 | | - | [<img src="./images/termdashdemo_0_7_0.gif" alt="termdashdemo" type="image/gif">](termdashdemo/termdashdemo.go) |
| 11 | + | [<img src="./doc/images/termdashdemo_0_7_0.gif" alt="termdashdemo" type="image/gif">](termdashdemo/termdashdemo.go) |
12 | 12 | | |
13 | | - | This project implements a cross-platform customizable terminal based dashboard. |
| 13 | + | Termdash is a cross-platform customizable terminal based dashboard. |
14 | 14 | | The feature set is inspired by the |
15 | 15 | | [gizak/termui](http://github.com/gizak/termui) project, which in turn was |
16 | | - | inspired by a javascript based |
| 16 | + | inspired by |
17 | 17 | | [yaronn/blessed-contrib](http://github.com/yaronn/blessed-contrib). |
18 | 18 | | |
19 | 19 | | This rewrite focuses on code readability, maintainability and testability, see |
| skipped 1 lines |
21 | 21 | | [requirements](doc/requirements.md). See the [high-level design](doc/hld.md) |
22 | 22 | | for more details. |
23 | 23 | | |
| 24 | + | # Public API and status |
| 25 | + | |
| 26 | + | The public API surface is documented in the |
| 27 | + | [wiki](http://github.com/mum4k/termdash/wiki). |
| 28 | + | |
| 29 | + | Private packages can be identified by the presence of the **/internal/** |
| 30 | + | directory in their import path. Stability of the private packages isn't |
| 31 | + | guaranteed and changes won't be backward compatible. |
| 32 | + | |
| 33 | + | There might still be breaking changes to the public API, at least until the |
| 34 | + | project reaches version 1.0.0. Any breaking changes will be published in the |
| 35 | + | [changelog](CHANGELOG.md). |
| 36 | + | |
24 | 37 | | # Current feature set |
25 | 38 | | |
26 | 39 | | - Full support for terminal window resizing throughout the infrastructure. |
| skipped 5 lines |
32 | 45 | | - UTF-8 for all text elements. |
33 | 46 | | - Drawing primitives (Go functions) for widget development with character and |
34 | 47 | | sub-character resolution. |
35 | | - | |
36 | | - | See the [changelog](CHANGELOG.md) for more details. |
37 | 48 | | |
38 | 49 | | # Installation |
39 | 50 | | |
| skipped 15 lines |
55 | 66 | | |
56 | 67 | | # Documentation |
57 | 68 | | |
58 | | - | Code documentation can be viewed in |
59 | | - | [godoc](https://godoc.org/github.com/mum4k/termdash). |
60 | | - | |
61 | | - | Project documentation is available in the [doc](doc/) directory. |
| 69 | + | Please refer to the [Termdash wiki](http://github.com/mum4k/termdash/wiki) for |
| 70 | + | all documentation and resources. |
62 | 71 | | |
63 | | - | ## Implemented Widgets |
| 72 | + | # Implemented Widgets |
64 | 73 | | |
65 | | - | ### The Button |
| 74 | + | ## The Button |
66 | 75 | | |
67 | 76 | | Allows users to interact with the application, each button press runs a callback function. |
68 | 77 | | Run the |
| skipped 3 lines |
72 | 81 | | go run github.com/mum4k/termdash/widgets/button/buttondemo/buttondemo.go |
73 | 82 | | ``` |
74 | 83 | | |
75 | | - | [<img src="./images/buttondemo.gif" alt="buttondemo" type="image/gif">](widgets/button/buttondemo/buttondemo.go) |
| 84 | + | [<img src="./doc/images/buttondemo.gif" alt="buttondemo" type="image/gif" width="50%">](widgets/button/buttondemo/buttondemo.go) |
76 | 85 | | |
77 | | - | ### The Gauge |
| 86 | + | ## The Gauge |
78 | 87 | | |
79 | 88 | | Displays the progress of an operation. Run the |
80 | 89 | | [gaugedemo](widgets/gauge/gaugedemo/gaugedemo.go). |
| skipped 2 lines |
83 | 92 | | go run github.com/mum4k/termdash/widgets/gauge/gaugedemo/gaugedemo.go |
84 | 93 | | ``` |
85 | 94 | | |
86 | | - | [<img src="./images/gaugedemo.gif" alt="gaugedemo" type="image/gif">](widgets/gauge/gaugedemo/gaugedemo.go) |
| 95 | + | [<img src="./doc/images/gaugedemo.gif" alt="gaugedemo" type="image/gif">](widgets/gauge/gaugedemo/gaugedemo.go) |
87 | 96 | | |
88 | | - | ### The Donut |
| 97 | + | ## The Donut |
89 | 98 | | |
90 | 99 | | Visualizes progress of an operation as a partial or a complete donut. Run the |
91 | 100 | | [donutdemo](widgets/donut/donutdemo/donutdemo.go). |
| skipped 2 lines |
94 | 103 | | go run github.com/mum4k/termdash/widgets/donut/donutdemo/donutdemo.go |
95 | 104 | | ``` |
96 | 105 | | |
97 | | - | [<img src="./images/donutdemo.gif" alt="donutdemo" type="image/gif">](widgets/donut/donutdemo/donutdemo.go) |
| 106 | + | [<img src="./doc/images/donutdemo.gif" alt="donutdemo" type="image/gif">](widgets/donut/donutdemo/donutdemo.go) |
98 | 107 | | |
99 | | - | ### The Text |
| 108 | + | ## The Text |
100 | 109 | | |
101 | 110 | | Displays text content, supports trimming and scrolling of content. Run the |
102 | 111 | | [textdemo](widgets/text/textdemo/textdemo.go). |
| skipped 2 lines |
105 | 114 | | go run github.com/mum4k/termdash/widgets/text/textdemo/textdemo.go |
106 | 115 | | ``` |
107 | 116 | | |
108 | | - | [<img src="./images/textdemo.gif" alt="textdemo" type="image/gif">](widgets/text/textdemo/textdemo.go) |
| 117 | + | [<img src="./doc/images/textdemo.gif" alt="textdemo" type="image/gif">](widgets/text/textdemo/textdemo.go) |
109 | 118 | | |
110 | | - | ### The SparkLine |
| 119 | + | ## The SparkLine |
111 | 120 | | |
112 | 121 | | Draws a graph showing a series of values as vertical bars. The bars can have |
113 | 122 | | sub-cell height. Run the |
| skipped 3 lines |
117 | 126 | | go run github.com/mum4k/termdash/widgets/sparkline/sparklinedemo/sparklinedemo.go |
118 | 127 | | ``` |
119 | 128 | | |
120 | | - | [<img src="./images/sparklinedemo.gif" alt="sparklinedemo" type="image/gif" width="50%">](widgets/sparkline/sparklinedemo/sparklinedemo.go) |
| 129 | + | [<img src="./doc/images/sparklinedemo.gif" alt="sparklinedemo" type="image/gif" width="50%">](widgets/sparkline/sparklinedemo/sparklinedemo.go) |
121 | 130 | | |
122 | | - | ### The BarChart |
| 131 | + | ## The BarChart |
123 | 132 | | |
124 | 133 | | Displays multiple bars showing relative ratios of values. Run the |
125 | 134 | | [barchartdemo](widgets/barchart/barchartdemo/barchartdemo.go). |
| skipped 2 lines |
128 | 137 | | go run github.com/mum4k/termdash/widgets/barchart/barchartdemo/barchartdemo.go |
129 | 138 | | ``` |
130 | 139 | | |
131 | | - | [<img src="./images/barchartdemo.gif" alt="barchartdemo" type="image/gif" width="50%">](widgets/barchart/barchartdemo/barchartdemo.go) |
| 140 | + | [<img src="./doc/images/barchartdemo.gif" alt="barchartdemo" type="image/gif" width="50%">](widgets/barchart/barchartdemo/barchartdemo.go) |
132 | 141 | | |
133 | | - | ### The LineChart |
| 142 | + | ## The LineChart |
134 | 143 | | |
135 | 144 | | Displays series of values on a line chart, supports zoom triggered by mouse |
136 | 145 | | events. Run the |
| skipped 3 lines |
140 | 149 | | go run github.com/mum4k/termdash/widgets/linechart/linechartdemo/linechartdemo.go |
141 | 150 | | ``` |
142 | 151 | | |
143 | | - | [<img src="./images/linechartdemo.gif" alt="linechartdemo" type="image/gif" width="70%">](widgets/linechart/linechartdemo/linechartdemo.go) |
| 152 | + | [<img src="./doc/images/linechartdemo.gif" alt="linechartdemo" type="image/gif" width="70%">](widgets/linechart/linechartdemo/linechartdemo.go) |
144 | 153 | | |
145 | | - | ### The SegmentDisplay |
| 154 | + | ## The SegmentDisplay |
146 | 155 | | |
147 | 156 | | Displays text by simulating a 16-segment display. Run the |
148 | 157 | | [segmentdisplaydemo](widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go). |
| skipped 2 lines |
151 | 160 | | go run github.com/mum4k/termdash/widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go |
152 | 161 | | ``` |
153 | 162 | | |
154 | | - | [<img src="./images/segmentdisplaydemo.gif" alt="segmentdisplaydemo" type="image/gif">](widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go) |
| 163 | + | [<img src="./doc/images/segmentdisplaydemo.gif" alt="segmentdisplaydemo" type="image/gif">](widgets/segmentdisplay/segmentdisplaydemo/segmentdisplaydemo.go) |
155 | 164 | | |
156 | 165 | | # Contributing |
157 | 166 | | |
| skipped 13 lines |
171 | 180 | | development](doc/widget_development.md) section. |
172 | 181 | | |
173 | 182 | | |
174 | | - | ## Disclaimer |
| 183 | + | # Disclaimer |
175 | 184 | | |
176 | 185 | | This is not an official Google product. |
177 | 186 | | |