diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 161 |
1 files changed, 149 insertions, 12 deletions
@@ -5,6 +5,8 @@ </a>  + +    @@ -12,14 +14,11 @@ [](https://github.com/sponsors/aristocratos) [](https://ko-fi.com/aristocratos) [](https://snapcraft.io/btop) -[](https://github.com/aristocratos/btop/actions) +[](https://github.com/aristocratos/btop/actions/workflows/continuous-build-linux.yml) [](https://github.com/aristocratos/btop/actions/workflows/continuous-build-macos.yml) - ## Index - - * [News](#news) * [Documents](#documents) * [Description](#description) @@ -29,9 +28,10 @@ * [Prerequisites](#prerequisites) (Read this if you are having issues!) * [Screenshots](#screenshots) * [Keybindings](#help-menu) -* [Installation](#installation) -* [Manual compilation](#compilation) -* [Install the snap](#install-the-snap) +* [Installation Linux/OSX](#installation) +* [Compilation Linux](#compilation-linux) +* [Compilation OSX](#compilation-osx) +* [Installing the snap](#installing-the-snap) * [Configurability](#configurability) * [License](#license) @@ -39,9 +39,48 @@ ### Under development +##### 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. + +Big thank you to [@joske](https://github.com/joske) who wrote the vast majority of the implementation! + +<details> +<summary>More...</summary> + +##### 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. + +If you want to help out, test for bugs/fix bugs or just try out the branches: + +**OSX** +```bash +# Install and use Homebrew or MacPorts package managers for easy dependency installation +brew install coreutils make gcc@11 +git clone https://github.com/aristocratos/btop.git +cd btop +git checkout OSX +gmake +``` + +**FreeBSD** +```bash +sudo pkg install gmake gcc11 coreutils git +git clone https://github.com/aristocratos/btop.git +cd btop +git checkout freebsd +gmake +``` + +Note that GNU make (`gmake`) is recommended but not required for OSX but it is required on FreeBSD. + + ##### 6 October 2021 -OsX development have been started by @joske , big thanks :) +OsX 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 @@ -68,6 +107,8 @@ Windows support is not in the plans as of now, but if anyone else wants to take 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. +</details> + ## Documents **[CHANGELOG.md](CHANGELOG.md)** @@ -176,9 +217,11 @@ Also needs a UTF8 locale and a font that covers: ## Installation -**Binary release (statically compiled with musl, for kernel 2.6.39 and newer)** +**Binaries for Linux are statically compiled with musl and works on kernel 2.6.39 and newer** + +1. **Download btop-(VERSION)-(ARCH)-(PLATFORM).tbz from [latest release](https://github.com/aristocratos/btop/releases/latest) and unpack to a new folder** -1. **Download btop-(VERSION)-(PLATFORM)-(ARCH).tbz from [latest release](https://github.com/aristocratos/btop/releases/latest) and unpack to a new folder** + **Notice! Use x86_64 for 64-bit x86 systems, i486 and i686 are 32-bit!** 2. **Install (from created folder)** @@ -232,7 +275,14 @@ Also needs a UTF8 locale and a font that covers: sudo zypper in btop ``` -## Compilation +**Binary release on Homebrew (macOS (x86_64 & ARM64) / Linux (x86_64))** + +* **[Homebrew](https://formulae.brew.sh/formula/btop)** + ```bash + brew install btop + ``` + +## Compilation Linux Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary). @@ -324,7 +374,94 @@ Also needs a UTF8 locale and a font that covers: make help ``` -## Install the snap +## Compilation OSX + + Needs GCC 10 or higher, (GCC 11 or above strongly recommended for better CPU efficiency in the compiled binary). + + The makefile also needs GNU coreutils and `sed`. + + Install and use Homebrew or MacPorts package managers for easy dependency installation + +1. **Install dependencies (example for Homebrew)** + + ``` bash + brew install coreutils make gcc@11 + ``` + +2. **Clone repository** + + ``` bash + git clone https://github.com/aristocratos/btop.git + cd btop + ``` + +3. **Compile** + + Append `STATIC=true` to `make` command for static compilation (only libgcc and libstdc++ will be static!). + + Append `QUIET=true` for less verbose output. + + Append `STRIP=true` to force stripping of debug symbols (adds `-s` linker flag). + + Append `ARCH=<architecture>` to manually set the target architecture. + If omitted the makefile uses the machine triple (output of `-dumpmachine` compiler parameter) to detect the target system. + + Use `ADDFLAGS` variable for appending flags to both compiler and linker. + + For example: `ADDFLAGS=-march=native` might give a performance boost if compiling only for your own system. + + ``` bash + gmake + ``` + +4. **Install** + + Append `PREFIX=/target/dir` to set target, default: `/usr/local` + + Notice! Only use "sudo" when installing to a NON user owned directory. + + ``` bash + sudo gmake install + ``` + +5. **(Recommended) Set suid bit to make btop always run as root (or other user)** + + No need for `sudo` to see information for non user owned processes and to enable signal sending to any process. + + Run after make install and use same PREFIX if any was used at install. + + Set `SU_USER` and `SU_GROUP` to select user and group, default is `root` and `wheel` + + ``` bash + sudo gmake setuid + ``` + +* **Uninstall** + + ``` bash + sudo gmake uninstall + ``` + +* **Remove any object files from source dir** + + ```bash + gmake clean + ``` + +* **Remove all object files, binaries and created directories in source dir** + + ```bash + gmake distclean + ``` + +* **Show help** + + ```bash + gmake help + ``` + + +## Installing the snap [](https://snapcraft.io/btop) * **Install the snap** |