OrgGo/termdash
1
0
Fork 0
mirror of https://github.com/mum4k/termdash.git synced 2025-04-25 13:48:50 +08:00
Code Issues Projects Releases Wiki Activity

Summary of background and design goals.

Browse Source
This commit is contained in:
Jakub Sobon 2018-03-24 12:14:06 +00:00
parent d0e9717a83
commit 3ee3375d0d
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,2 +1,24 @@
# termdash # termdash
Terminal based dashboard.
This project implements a terminal based dashboard. The feature set is inspired
by the [gizak/termui](http://github.com/gizak/termui) project. Why the rewrite
you ask?
1. The above mentioned project is abandoned and isn't maintained anymore.
1. The project doesn't follow the design goals outlined below.
1. The project is released under a license I cannot use.
# Design goals
This effort is focused on good software design and maintainability. By a good
software I mean:
1. Write readable, well documented code.
1. Provide an infrastructure that allows development of individual dashboard
components in separation.
1. The infrastructure should enforce consistency between the dashboard components.
1. Focus on maintainability, the infrastructure and dashboard components must
have good test coverage, the repository must have CI/CD enabled.
On top of that - let's have fun, learn something and become better developers
together.