diff options
| author | Manos Pitsidianakis <el13635@mail.ntua.gr> | 2019-10-26 08:56:41 +0300 |
|---|---|---|
| committer | Manos Pitsidianakis <el13635@mail.ntua.gr> | 2019-10-26 08:56:41 +0300 |
| commit | 2973194d9d1d9a9dc91f8824ae929dd1d0ed26a2 (patch) | |
| tree | 7b0325f2ffb571fe3a8ae123f69499e662177352 | |
| parent | a487c4e01dd07e67449b69f1bab90d13c59b54d9 (diff) | |
Update README
Convert README to Markdown, add new shortcuts etc
| -rw-r--r-- | README | 30 | ||||
| -rw-r--r-- | README.md | 47 |
2 files changed, 47 insertions, 30 deletions
@@ -1,30 +0,0 @@ -NAME - bb — your system's Big Brother - -SYNOPSIS - bb - -DESCRIPTION - simple process viewer made for fun - screenshot: see ./screenshot.png - -BUILD - prerequisites: rustc, cargo >= 1.36, Linux - - execute `cargo build --release`, resulting binary will be in - ./target/release/bb - -SHORTCUTS - 'F' Follow process and its children. Type the pid you want to follow - 'k' kill process under cursor - press enter to confirm kill, or esc to cancel - 'f' (un)freeze process list updates - Esc cancel action -AUTHORS - Copyright 2019 Manos Pitsidianakis <epilys@nessuent.xyz> Released - under the GPL, version 3 or greater. This software carries no warranty of - any kind. (See COPYING for full copyright and warranty notices.) - - ⟨https://nessuent.xyz/⟩ - - September 04, 2019 diff --git a/README.md b/README.md new file mode 100644 index 0000000..71d2f89 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +## NAME + bb — your system's Big Brother + +## SYNOPSIS +``` + bb +``` + +## DESCRIPTION +simple process viewer (for functionalities, see shortcuts below) + + + +## WHY +This is a "weekend" side-project made for fun, but it ended up somewhat useful and fast. Performance seems on par with `htop` without having done any benchmarks, however in contrast to `htop`, `bb` doesn't leave artifacts when it redraws the screen. I am not completely sure this is `htop`'s fault though, feel free to correct me. + +## INSTALL +Prerequisites: [cargo](https://www.rust-lang.org/tools/install) >= 1.36, Linux + +``` +cargo install bb +``` + +## BUILD + Prerequisites: rustc, cargo >= 1.36, Linux + + Execute `cargo build --release`, resulting binary will be in + ./target/release/bb + +## SHORTCUTS +``` + 'F' Follow process and its children. Type the pid you want to follow + 'k' Kill process under cursor + Press Enter to confirm kill, or Esc to cancel + 'f' (un)freeze process list updates + '/' Filter process list + Esc Cancel action +``` + +## AUTHORS + Copyright 2019 Manos Pitsidianakis <epilys@nessuent.xyz> Released + under the GPL, version 3 or greater. This software carries no warranty of + any kind. (See COPYING for full copyright and warranty notices.) + +⟨ https://nessuent.xyz/ ⟩ + + September 04, 2019 |