diff options
| author | Sean E. Russell <ser@ser1.net> | 2020-02-27 16:13:23 -0600 |
|---|---|---|
| committer | Sean E. Russell <ser@ser1.net> | 2020-02-27 16:13:23 -0600 |
| commit | 4fce1654c5c263797205997e7635c7d06c393a85 (patch) | |
| tree | 06a0e382b9cfc292d978d45033f26aaaaa28fa12 /docs | |
| parent | e38f6fc8c488ed9379efc32060be18f45b18329b (diff) | |
| parent | a5b039cd923270683a777c7e3851116076a663e9 (diff) | |
Merge branch 'v3.4.x' into nvidia
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/extensions.md | 22 | ||||
| -rw-r--r-- | docs/grid-fill.md | 42 | ||||
| -rw-r--r-- | docs/releasing.md | 37 |
3 files changed, 101 insertions, 0 deletions
diff --git a/docs/extensions.md b/docs/extensions.md new file mode 100644 index 0000000..b88f63f --- /dev/null +++ b/docs/extensions.md @@ -0,0 +1,22 @@ +% Plugins + + +# Extensions + +- Plugins will supply an `Init()` function that will call the appropriate + `Register\*()` functions in the `github.com/xxxserxxx/gotop/devices` package. +- `devices` will supply: + - RegisterCPU (opt) + - Counts (req) + - Percents (req) + - RegisterMem (opt) + - RegisterTemp (opt) + - RegisterShutdown (opt) + +# gotop + +- Command line -P, comma separated list of plugin .so +- gotop will look in `pwd` and then in \$XDG_CONFIG_HOME/gotop +- When loaded, gotop will call lib#Init() + +When exited cleanly, gotop will call all registered shutdown functions. diff --git a/docs/grid-fill.md b/docs/grid-fill.md new file mode 100644 index 0000000..554b524 --- /dev/null +++ b/docs/grid-fill.md @@ -0,0 +1,42 @@ +T is max height in row +S(T) is all widgets with height T +R(T) is all widgets with height < T +X is len(R) > 0 ? 1 : 0 +C is len(S) + X +Make row +Make C columns +Place S +Recurse with R; place result + + + 1 2 3 4 5 +cpu/2............... mem/1. 6:procs/2.......... +3:temp/1. 2:disk/2......... |.................. +|........ |................ |.................. +|........ power/2.......... |.................. +net/2............... batt.. |.................. + + 1 2 3 4 5 +cpu/2............... 6:procs/2........ mem/1... +2:disk/2............ |................ 3:temp/1 +|................... |................ |....... +power/2............. |................ |....... +net/2............... |................ batt + + 1 2 3 4 5 +1x2................. 3x2.............. 1x1..... 221 221 +2x2................. ||||||||||||||||| 3x1..... 21 2x1 +|||||||||||||||||||| ||||||||||||||||| |||||||| +1x1...... 1x1...... 1x2.............. 1x1..... 1121 +1x2................. 1x2.............. |||||||| 22 22x +1x1...... 1x4................................... 14 + +initial columns = initial row +fill + pattern for row + does pattern fit columns? + yes: place widgets + no: new row w/ new columns; fill + +does fit + cw < patt_c_w diff --git a/docs/releasing.md b/docs/releasing.md new file mode 100644 index 0000000..540c950 --- /dev/null +++ b/docs/releasing.md @@ -0,0 +1,37 @@ +Current steps for a release: + +### gotop +1. Update Version in main.go +2. Update CHANGELOG.md +3. Tag +4. Push everything +5. ./make.sh +6. Create github release + +### Homebrew +1. Change homebrew-gotop +``` +curl --output - -L https://github.com/xxxserxxx/gotop/releases/download/v3.3.2/gotop_3.3.2_linux_amd64.tgz | sha256sum +curl --output - -L https://github.com/xxxserxxx/gotop/releases/download/v3.3.2/gotop_3.3.2_darwin_amd64.tgz | sha256sum +``` + +### AUR +1. Update aur/PKGBUILD +2. namcap PKGBUILD +3. makepkg +4. makepkg -g +5. makepkg --printsrcinfo \> .SRCINFO +6. Commit everything +7. push +``` +curl -L https://github.com/xxxserxxx/gotop/archive/v3.3.2.tar.gz | sha256sum +``` + +### AUR-BIN +1. Update aur-bin/PKGBUILD +2. namcap PKGBUILD +3. makepkg +4. makepkg -g +5. makepkg --printsrcinfo \> .SRCINFO +6. Commit everything +7. push aur-bin |