summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSean E. Russell <ser@ser1.net>2020-02-23 08:13:43 -0600
committerSean E. Russell <ser@ser1.net>2020-02-23 08:16:02 -0600
commit39dc97b37f710092e1db042b37dd5f9847997336 (patch)
treedec1d7a1b034166b6ce66be7bd0c6b296ba62349
parent9cc6cab6416798eb061b0c3ebafd4b6d47470a52 (diff)
Documentation clean-up.
-rw-r--r--README.md19
-rw-r--r--assets/screenshots/battery.pngbin95426 -> 124394 bytes
-rw-r--r--assets/screenshots/demo.gif (renamed from assets/demos/demo.gif)bin150039 -> 150039 bytes
-rw-r--r--assets/screenshots/kitchensink.gifbin0 -> 235143 bytes
-rw-r--r--assets/screenshots/minimal.pngbin44312 -> 88647 bytes
-rw-r--r--assets/screenshots/procs.pngbin0 -> 163651 bytes
-rw-r--r--layout/layout.go1
7 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index ca7be96..c37da93 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@ Another terminal based graphical activity monitor, inspired by [gtop](https://gi
The original author of gotop has re-implemented the application in Rust, as [ytop](https://github.com/cjbassi/ytop). This is a fork of original gotop project with a new maintainer.
-<img src="./assets/demos/demo.gif" />
-<img src="./assets/screenshots/minimal.png" width="96%" />
+<img src="./assets/screenshots/demo.gif" />
+<img src="./assets/screenshots/kitchensink.gif" />
</div>
@@ -166,21 +166,30 @@ build massive edifices, you're in for disappointment.
### CLI Options
`-c`, `--color=NAME` Set a colorscheme.
-`-m`, `--minimal` Only show CPU, Mem and Process widgets. (DEPRECATED for `-l minimal`)
+`-m`, `--minimal` Only show CPU, Mem and Process widgets. (DEPRECATED, use `-l minimal`)
`-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1].
`-V`, `--version` Print version and exit.
`-p`, `--percpu` Show each CPU in the CPU widget.
`-a`, `--averagecpu` Show average CPU in the CPU widget.
`-f`, `--fahrenheit` Show temperatures in fahrenheit.
`-s`, `--statusbar` Show a statusbar with the time.
-`-b`, `--battery` Show battery level widget (`minimal` turns off). [preview](./assets/screenshots/battery.png) (DEPRECATED for `-l battery`)
-`-i`, `--interface=NAME` Select network interface [default: all].
+`-b`, `--battery` Show battery level widget (`minimal` turns off). (DEPRECATED, use `-l battery`)
+`-i`, `--interface=NAME` Select network interface [default: all].
`-l`, `--layout=NAME` Choose a layout. gotop searches for a file by NAME in \$XDG_CONFIG_HOME/gotop, then relative to the current path. "-" reads a layout from stdin, allowing for simple, one-off layouts such as `echo net | gotop -l -`
Several interfaces can be defined using comma separated values.
Interfaces can also be ignored using `!`
+## More screen shots
+
+#### "-l battery"
+<img src="./assets/screenshots/battery.png" />
+#### "-l minimal"
+<img src="./assets/screenshots/minimal.png" />
+#### Custom (layouts/procs)
+<img src="./assets/screenshots/procs.png" />
+
## Built With
- [gizak/termui](https://github.com/gizak/termui)
diff --git a/assets/screenshots/battery.png b/assets/screenshots/battery.png
index b70f2ab..4698d1a 100644
--- a/assets/screenshots/battery.png
+++ b/assets/screenshots/battery.png
Binary files differ
diff --git a/assets/demos/demo.gif b/assets/screenshots/demo.gif
index 7ed5d1c..7ed5d1c 100644
--- a/assets/demos/demo.gif
+++ b/assets/screenshots/demo.gif
Binary files differ
diff --git a/assets/screenshots/kitchensink.gif b/assets/screenshots/kitchensink.gif
new file mode 100644
index 0000000..6061c84
--- /dev/null
+++ b/assets/screenshots/kitchensink.gif
Binary files differ
diff --git a/assets/screenshots/minimal.png b/assets/screenshots/minimal.png
index efe5cc3..354b60b 100644
--- a/assets/screenshots/minimal.png
+++ b/assets/screenshots/minimal.png
Binary files differ
diff --git a/assets/screenshots/procs.png b/assets/screenshots/procs.png
new file mode 100644
index 0000000..0e4e7a6
--- /dev/null
+++ b/assets/screenshots/procs.png
Binary files differ
diff --git a/layout/layout.go b/layout/layout.go
index 3214b97..1dbcaa4 100644
--- a/layout/layout.go
+++ b/layout/layout.go
@@ -236,6 +236,7 @@ func countMaxHeight(rs [][]widgetRule) int {
// deepFindProc looks in the UI widget tree for the ProcWidget,
// and returns it if found or nil if not.
func deepFindProc(gs interface{}) *widgets.ProcWidget {
+ // FIXME: `procs` layout isn't passing down keystrokes
// Recursive function #1. Recursion is OK here because the number
// of UI elements, even in a very complex UI, is going to be
// relatively small.