tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README

This commit is contained in:
ClementTsang 2021-05-31 00:40:37 -04:00
parent 60a759c416
commit 1346b4de3e
2 changed files with 3 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
.github/release_checklist.md vendored
View File

@ -1,65 +0,0 @@
# Release checklist
This checklist is mostly for me personally - just want to have a easy to refer to record for what I should do before I release.
## General
- Did travis pass (obviously)?
- Did you uptick the version?
- Is every feature tested?
- Are any new bugs introduced in the core features?
- Did you test:
- Searching
- Do the modifiers work?
- Do all chars work?
- Basic widget movement
- Flags
- Config files
- Colouring
- Did you _really_ test all this?
- Did you test `cargo install` (I don't want to ever have to deal with that fiasco again, jeez)?
- Is documentation up to spec?
- If everything is good, create a release branch!
## Linux
### Arch
- Did you edit the PKGBUILD with the correct version + hash?
- Did you add a .SRCINFO?
- Did you test it?
- Did you commit it all?
### Debian
- Did you edit the new `.deb` file version in?
## macOS
- Did you update the `bottom.rb` file with the correct version + hash?
- Did you test it?
## Windows
- Did you edit the nupkg?
- Did you test if it works?

8
README.md
View File

@ -3,7 +3,7 @@
![ci](https://github.com/ClementTsang/bottom/workflows/ci/badge.svg)
[![crates.io link](https://img.shields.io/crates/v/bottom.svg)](https://crates.io/crates/bottom)
A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by both [gtop](https://github.com/aksakalli/gtop) and [gotop](https://github.com/cjbassi/gotop).
A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by [gtop](https://github.com/aksakalli/gtop), [gotop](https://github.com/xxxserxxx/gotop), and [htop](https://github.com/htop-dev/htop/).
![Quick demo recording showing off searching, expanding, and process killing.](assets/demo.gif) _Theme based on [gruvbox](https://github.com/morhetz/gruvbox)_ (`--color gruvbox`). _Font is [IBM Plex Mono](https://www.ibm.com/plex/), terminal is [Kitty](https://sw.kovidgoyal.net/kitty/)._
@ -818,10 +818,8 @@ Thanks to all contributors ([emoji key](https://allcontributors.org/docs/en/emoj
## Thanks
- This project is very much inspired by [gotop](https://github.com/cjbassi/gotop),
its successor [ytop](https://github.com/cjbassi/ytop), and [gtop](https://github.com/aksakalli/gtop).
- Basic mode is heavily inspired by [htop's](https://hisham.hm/htop/) design.
- This project is very much inspired by [gotop](https://github.com/xxxserxxx/gotop),
[ytop](https://github.com/cjbassi/ytop), [gtop](https://github.com/aksakalli/gtop), and [htop](https://github.com/htop-dev/htop/).
- This application was written with many, _many_ libraries, and built on the
work of many talented people. This application would be impossible without their