From f2db8dbbb64eff6b7a94effa1a0f9c7ec785963b Mon Sep 17 00:00:00 2001 From: Franciosi Date: Tue, 27 Sep 2022 18:55:28 -0300 Subject: [PATCH] Updated README.md s/OSX/macOS and small text improves --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e84c13d..4fc8ff3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![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) ![Usage](https://img.shields.io/badge/Usage-System%20resource%20monitor-yellow) ![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) [![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 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 @@ -28,9 +28,9 @@ * [Prerequisites](#prerequisites) (Read this if you are having issues!) * [Screenshots](#screenshots) * [Keybindings](#help-menu) -* [Installation Linux/OSX](#installation) +* [Installation Linux/macOS](#installation) * [Compilation Linux](#compilation-linux) -* [Compilation OSX](#compilation-osx) +* [Compilation macOS](#compilation-macos-osx) * [Compilation FreeBSD](#compilation-freebsd) * [Installing the snap](#installing-the-snap) * [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! -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 -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. -Macos binaries + installer are included for both x86 and ARM64 (Apple Silicon) in the releases. +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. 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 -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. -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. +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 [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: -**OSX** +**macOS / OSX** ```bash # Install and use Homebrew or MacPorts package managers for easy dependency installation brew install coreutils make gcc@11 @@ -88,12 +88,12 @@ git checkout freebsd 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 -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. ##### 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: -* 1.1.0 Mac OsX support +* 1.1.0 macOS [OSX] support * 1.2.0 FreeBSD support * 1.3.0 Support for GPU monitoring * 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 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. @@ -148,9 +148,9 @@ C++ version and continuation of [bashtop](https://github.com/aristocratos/bashto * Send any signal to selected process. * UI menu for changing all config file options. * Auto scaling graph for network usage. -* Shows IO activity and speeds for disks +* Shows IO activity and speeds for disks. * Battery meter -* Selectable symbols for the graphs +* Selectable symbols for the graphs. * Custom presets * And more... @@ -394,7 +394,7 @@ Also needs a UTF8 locale and a font that covers: 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).