diff --git a/README.md b/README.md index 2ed990c..0607ffe 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # ![bashtop](Imgs/logo-t.png) -![os](https://img.shields.io/badge/Os-Linux-yellow?logo=linux) -![os](https://img.shields.io/badge/Os-OSX-green?logo=apple) -![usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-red) +![Linux](https://img.shields.io/badge/-Linux-grey?logo=linux) +![OSX](https://img.shields.io/badge/-OSX-black?logo=apple) +![FreeBSD](https://img.shields.io/badge/-FreeBSD-red?logo=freebsd) +![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-blue) ![Bash](https://img.shields.io/badge/Bash-v4.4%5E-green?logo=GNU%20bash) -![Python](https://img.shields.io/badge/Python-v3.6%5E-purple?logo=python) +![Python](https://img.shields.io/badge/Python-v3.6%5E-orange?logo=python) ![bashtop_version](https://img.shields.io/github/v/tag/aristocratos/bashtop?label=version) [![Donate](https://img.shields.io/badge/-Donate-yellow?logo=paypal)](https://paypal.me/aristocratos) [![Sponsor](https://img.shields.io/badge/-Sponsor-red?logo=github)](https://github.com/sponsors/aristocratos) @@ -62,16 +63,14 @@ Let me know if you want to contribute with new themes. ## Upcoming -#### (Python port) - ~~Currently rewriting to use python3 [psutil](https://github.com/giampaolo/psutil) for data collection instead of linux specific tools. This will add python 3 and psutil as dependencies, but will make bashtop cross platform compatible.~~ ~~This will be integrated in to main version when done and add the possibility to switch between psutil and linux tools for users running linux.~~ -Bashtop is now Mac OS X compatible! +Bashtop is now Mac OS X and FreeBSD compatible! -#### Update +#### Python port Work on a complete python port ~~will begin this summer~~ has begun. My aim is to keep it compatible with pypy3 for a lot of added efficiency. @@ -94,7 +93,7 @@ Any support is greatly appreciated! ## Compatibility -Should work on most modern linux distributions and on Mac OS X. +Should work on most modern linux distributions, on Mac OS X and on FreeBSD. Will not display correctly on the standard terminal on OSX! Recommended alternative [iTerm2](https://www.iterm2.com/) @@ -120,7 +119,7 @@ Dropbear seems to not be able to set correct locale. So if accessing bashtop ove ## Dependencies -## Linux and OSX +## Linux, OSX and FreeBSD **[bash](https://www.gnu.org/software/bash/)** (v4.4 or later) Script functionality will most probably break with earlier versions. Bash version 5 is highly recommended to make use of $EPOCHREALTIME variable instead of a lot of external date command calls. @@ -137,7 +136,7 @@ Bash version 5 is highly recommended to make use of $EPOCHREALTIME variable inst **[GNU awk](https://www.gnu.org/software/gawk/)** -## OSX or Linux using psutil for data collecton +## OSX and FreeBSD or Linux using psutil for data collection **[Python3](https://www.python.org/downloads/)** (v3.6 or later) @@ -151,7 +150,7 @@ Bash version 5 is highly recommended to make use of $EPOCHREALTIME variable inst (Optional Linux) **[iostat (part of sysstat)](https://github.com/sysstat/sysstat)** Needed if you want disk read/write stats and are not using psutil data collection. -(Optional OSX/Linux) **[curl](https://curl.haxx.se/download.html)** (v7.16.2 or later) Needed if you want messages about updates and the ability to download themes. +(Optional OSX/Linux/FreeBSD) **[curl](https://curl.haxx.se/download.html)** (v7.16.2 or later) Needed if you want messages about updates and the ability to download themes. ## Screenshots @@ -190,8 +189,17 @@ make sudo make install ``` -#### Manual installation Linux and OSX +#### Dependencies installation FreeBSD +>Install with pkg and pip + +``` bash +sudo pkg install coreutils gsed python3 git +sudo python3 -m ensurepip +sudo pip3 install psutil +``` + +#### Manual installation Linux, OSX and FreeBSD >Clone and install @@ -344,7 +352,7 @@ USAGE: bashtop Might finish off items out of order since I usually work on multiple at a time. - [x] Add options to change colors for text, graphs and meters. -- [x] Fix cross platform compatibility for Mac OSX and *BSD: Working on OSX, not fully tested on *BSD. +- [x] Fix cross platform compatibility for Mac OSX and *BSD: Working on OSX, and FreeBSD. - [x] Add support for showing AMD cpu temperatures. - [x] Add option to show tree view of processes. - [x] Add option to reset network download/upload totals.