CodeMirror/btop
1
0
Fork 0
mirror of https://github.com/aristocratos/btop.git synced 2024-05-20 04:13:18 +12:00
Code Issues Projects Releases Wiki Activity

Merge pull request #433 from franciosi/patch-3

Browse source 
Updated README.md
This commit is contained in:
Jakob P. Liljenberg 2022-10-02 13:56:42 +02:00 committed by GitHub
parent cd5374a89f f2db8dbbb6
commit 424b16ef77
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -5,7 +5,7 @@
</a> </a>
![Linux](https://img.shields.io/badge/-Linux-grey?logo=linux) ![Linux](https://img.shields.io/badge/-Linux-grey?logo=linux)
![OSX](https://img.shields.io/badge/-OSX-black?logo=apple) ![macOS](https://img.shields.io/badge/-OSX-black?logo=apple)
![FreeBSD](https://img.shields.io/badge/-FreeBSD-red?logo=freebsd) ![FreeBSD](https://img.shields.io/badge/-FreeBSD-red?logo=freebsd)
![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-yellow) ![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-yellow)
![c++20](https://img.shields.io/badge/cpp-c%2B%2B20-green) ![c++20](https://img.shields.io/badge/cpp-c%2B%2B20-green)
@ -15,7 +15,7 @@
[![Coffee](https://img.shields.io/badge/-Buy%20me%20a%20Coffee-grey?logo=Ko-fi)](https://ko-fi.com/aristocratos) [![Coffee](https://img.shields.io/badge/-Buy%20me%20a%20Coffee-grey?logo=Ko-fi)](https://ko-fi.com/aristocratos)
[![btop](https://snapcraft.io/btop/badge.svg)](https://snapcraft.io/btop) [![btop](https://snapcraft.io/btop/badge.svg)](https://snapcraft.io/btop)
[![Continuous Build Linux](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml) [![Continuous Build Linux](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml)
[![Continuous Build MacOS](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml) [![Continuous Build macOS](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml/badge.svg)](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml)
## Index ## Index
@ -28,9 +28,9 @@
* [Prerequisites](#prerequisites) (Read this if you are having issues!) * [Prerequisites](#prerequisites) (Read this if you are having issues!)
* [Screenshots](#screenshots) * [Screenshots](#screenshots)
* [Keybindings](#help-menu) * [Keybindings](#help-menu)
* [Installation Linux/OSX](#installation) * [Installation Linux/macOS](#installation)
* [Compilation Linux](#compilation-linux) * [Compilation Linux](#compilation-linux)
* [Compilation OSX](#compilation-osx) * [Compilation macOS](#compilation-macos-osx)
* [Compilation FreeBSD](#compilation-freebsd) * [Compilation FreeBSD](#compilation-freebsd)
* [Installing the snap](#installing-the-snap) * [Installing the snap](#installing-the-snap)
* [Configurability](#configurability) * [Configurability](#configurability)
@ -50,12 +50,12 @@ Release v1.2.0 with FreeBSD support. No release binaries for FreeBSD provided as
Again a big thanks to [@joske](https://github.com/joske) for his porting efforts! Again a big thanks to [@joske](https://github.com/joske) for his porting efforts!
Since compatibility with Linux, MacOS and FreeBSD are done, the focus going forward will be on new features like GPU monitoring. Since compatibility with Linux, macOS and FreeBSD are done, the focus going forward will be on new features like GPU monitoring.
##### 13 November 2021 ##### 13 November 2021
Release v1.1.0 with OSX support. Binaries in [continuous-build-macos](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml) are only x86 for now. Release v1.1.0 with macOS support. Binaries in [continuous-build-macos](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml) are only x86 for now.
Macos binaries + installer are included for both x86 and ARM64 (Apple Silicon) in the releases. macOS binaries + installer are included for both x86 and ARM64 (Apple Silicon) in the releases.
Big thank you to [@joske](https://github.com/joske) who wrote the vast majority of the implementation! Big thank you to [@joske](https://github.com/joske) who wrote the vast majority of the implementation!
@ -64,12 +64,12 @@ Big thank you to [@joske](https://github.com/joske) who wrote the vast majority
##### 30 October 2021 ##### 30 October 2021
Work on the OSX and FreeBSD branches, both initiated and mostly worked on by [@joske](https://github.com/joske), will likely be completed in the coming weeks. Work on the OSX [macOS] and FreeBSD branches, both initiated and mostly worked on by [@joske](https://github.com/joske), will likely be completed in the coming weeks.
The OSX branch has some memory leaks that needs to be sorted out and both have some issues with the processes cpu usage calculation and other smaller issues that needs fixing. The OSX [macOS] branch has some memory leaks that needs to be sorted out and both have some issues with the processes cpu usage calculation and other smaller issues that needs fixing.
If you want to help out, test for bugs/fix bugs or just try out the branches: If you want to help out, test for bugs/fix bugs or just try out the branches:
**OSX** **macOS / OSX**
```bash ```bash
# Install and use Homebrew or MacPorts package managers for easy dependency installation # Install and use Homebrew or MacPorts package managers for easy dependency installation
brew install coreutils make gcc@11 brew install coreutils make gcc@11
@ -88,12 +88,12 @@ git checkout freebsd
gmake gmake
``` ```
Note that GNU make (`gmake`) is recommended but not required for OSX but it is required on FreeBSD. Note that GNU make (`gmake`) is recommended but not required for macOS/OSX but it is required on FreeBSD.
##### 6 October 2021 ##### 6 October 2021
OsX development have been started by [@joske](https://github.com/joske), big thanks :) macOS development have been started by [@joske](https://github.com/joske), big thanks :)
See branch [OSX](https://github.com/aristocratos/btop/tree/OSX) for current progress. See branch [OSX](https://github.com/aristocratos/btop/tree/OSX) for current progress.
##### 18 September 2021 ##### 18 September 2021
@ -108,7 +108,7 @@ Please report any bugs to the [Issues](https://github.com/aristocratos/btop/issu
The development plan right now: The development plan right now:
* 1.1.0 Mac OsX support * 1.1.0 macOS [OSX] support
* 1.2.0 FreeBSD support * 1.2.0 FreeBSD support
* 1.3.0 Support for GPU monitoring * 1.3.0 Support for GPU monitoring
* 1.X.0 Other platforms and features... * 1.X.0 Other platforms and features...
@ -118,7 +118,7 @@ Windows support is not in the plans as of now, but if anyone else wants to take
##### 5 May 2021 ##### 5 May 2021
This project is gonna take some time until it has complete feature parity with bpytop, since all system information gathering will have to be written from scratch without any external libraries. This project is gonna take some time until it has complete feature parity with bpytop, since all system information gathering will have to be written from scratch without any external libraries.
And will need some help in the form of code contributions to get complete support for BSD and OSX. And will need some help in the form of code contributions to get complete support for BSD and macOS/OSX.
</details> </details>
@ -148,9 +148,9 @@ C++ version and continuation of [bashtop](https://github.com/aristocratos/bashto
* Send any signal to selected process. * Send any signal to selected process.
* UI menu for changing all config file options. * UI menu for changing all config file options.
* Auto scaling graph for network usage. * Auto scaling graph for network usage.
* Shows IO activity and speeds for disks * Shows IO activity and speeds for disks.
* Battery meter * Battery meter
* Selectable symbols for the graphs * Selectable symbols for the graphs.
* Custom presets * Custom presets
* And more... * And more...
@ -394,7 +394,7 @@ Also needs a UTF8 locale and a font that covers:
make help make help
``` ```
## Compilation OSX ## Compilation macOS OSX
Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary). Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary).