diff --git a/README.md b/README.md index f2495d6..3b1c24d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,35 @@

-
- -![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Dr-Noob/cpufetch?label=cpufetch) -[![GitHub Repo stars](https://img.shields.io/github/stars/Dr-Noob/cpufetch?color=4CC61F)](https://github.com/Dr-Noob/cpufetch/stargazers) -[![GitHub issues](https://img.shields.io/github/issues/Dr-Noob/cpufetch)](https://github.com/Dr-Noob/cpufetch/issues) -[![Packaging status](https://repology.org/badge/tiny-repos/cpufetch.svg)](https://repology.org/project/cpufetch/versions) -[![License](https://img.shields.io/github/license/Dr-Noob/cpufetch?color=orange)](https://github.com/Dr-Noob/cpufetch/blob/master/LICENSE) -

Simple yet fancy CPU architecture fetching tool

-  -![cpu1](pictures/i9.png) +

+
+ + + + + + + + + + + + +
+

+ +

+cpufetch is a command-line tool written in C that displays the CPU information in a clean and beautiful way +

+ +

+ +

+ # Table of contents @@ -24,12 +39,15 @@ - [1. Support](#1-support) - [2. Installation](#2-installation) - [2.1 Installing from a package](#21-installing-from-a-package) - - [2.2 Building from source (Linux/Windows/macOS)](#22-building-from-source-linuxwindowsmacos) + - [2.2 Building from source](#22-building-from-source) - [2.3 Android](#23-android) - [3. Examples](#3-examples) - - [3.1 x86_64 CPUs](#31-x86_64-cpus) - - [3.2 ARM CPUs](#32-arm-cpus) -- [4. Colors and style](#4-colors-and-style) + - [3.1 x86_64](#31-x86_64) + - [3.2 ARM](#32-arm) + - [3.3 PowerPC](#33-powerpc) +- [4. Colors](#4-colors) + - [4.1 Specifying a name](#41-specifying-a-name) + - [4.2 Specifying the colors in RGB format](#42-specifying-the-colors-in-rgb-format) - [5. Implementation](#5-implementation) - [6. Bugs or improvements](#6-bugs-or-improvements) - [7. Acknowledgements](#7-acknowledgements) @@ -37,31 +55,30 @@ -# 1. Support +## 1. Support -cpufetch supports the following architectures: -- x86 / x86_64 -- ARM -- PowerPC +| OS | x86_64 / x86 | ARM | PowerPC | +|:-----------:|:------------------:|:------------------:|:------------------:| +| GNU / Linux | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Windows | :heavy_check_mark: | :x: | :x: | +| Android | :heavy_check_mark: | :heavy_check_mark: | :x: | +| macOS | :heavy_check_mark: | :heavy_check_mark: | :x: | +| FreeBSD | :heavy_check_mark: | :x: | :x: | -| OS | x86_64 / x86 | ARM | PowerPC | Notes | -|:---------:|:------------------:|:------------------:|:------------------:|:-----------------:| -| GNU/Linux | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Best support | -| Windows | :heavy_check_mark: | :x: | :x: | Some information may be missing.
Colors will be used if supported | -| Android | :heavy_check_mark: | :heavy_check_mark: | :x: | Some information may be missing | -| macOS | :heavy_check_mark: | :heavy_check_mark: | :x: | Only the Apple M1 is supported in ARM | -| FreeBSD | :heavy_check_mark: | :x: | :x: | Some information may be missing. | +**NOTES:** +- Colors will be used in Windows only if the terminal supports it. +- Support in macOS ARM is limited to Apple M1 only -# 2. Installation -## 2.1 Installing from a package +## 2. Installation +### 2.1 Installing from a package Choose the right package for your operating system: [![Packaging status](https://repology.org/badge/vertical-allrepos/cpufetch.svg)](https://repology.org/project/cpufetch/versions) If there is no available package for your OS, you can download the cpufetch binary from [the releases page](https://github.com/Dr-Noob/cpufetch/releases), or [build cpufetch from source](#22-building-from-source-linuxwindowsmacos) (see below). -## 2.2 Building from source (Linux/Windows/macOS) -You will need a C compiler (e.g, `gcc`), and `make` to compile `cpufetch`. To do so, just clone the repo and run `make`: +### 2.2 Building from source +You will need a C compiler (e.g, `gcc`) and `make` to compile `cpufetch`. Just clone the repo and run `make`: ``` git clone https://github.com/Dr-Noob/cpufetch @@ -70,9 +87,7 @@ make ./cpufetch ``` -The Makefile is designed to work on Linux, Windows and macOS. - -## 2.3 Android +### 2.3 Android 1. Install `termux` app (terminal emulator) 2. Run `pkg install -y git make clang` inside termux. 3. Build from source normally: @@ -81,45 +96,65 @@ The Makefile is designed to work on Linux, Windows and macOS. - make - ./cpufetch -# 3. Examples -Here are more examples of how `cpufetch` looks on different CPUs. +## 3. Examples +### 3.1 x86_64 -## 3.1 x86_64 CPUs +

+

AMD EPYC HPC server

+

+

Intel Xeon HPC server

-![cpu2](pictures/epyc.png) +### 3.2 ARM -![cpu3](pictures/cascade_lake.png) +

+ +  + +

+

Samsung Galaxy S8 (left) Xiaomi Redmi Note 7 (right)

-## 3.2 ARM CPUs +### 3.3 PowerPC -![cpu4](pictures/exynos.png) +

+

Talos II

-![cpu5](pictures/snapdragon.png) +## 4. Colors +By default, `cpufetch` will print the CPU logo with the system colorscheme. However, you can set a custom color scheme in two different ways: -# 4. Colors and style -By default, `cpufetch` will print the CPU art with the system colorscheme. However, you can always set a custom color scheme, either -specifying Intel or AMD, or specifying the colors in RGB format: +### 4.1 Specifying a name + + By specifying a name, cpufetch will use the specific colors of each manufacture. Valid values are: + +- intel +- intel-new +- amd +- ibm +- arm ``` ./cpufetch --color intel (default color for Intel) -./cpufetch --color amd (default color for AMD) -./cpufetch --color 239,90,45:210,200,200:100,200,45:0,200,200 (example) ``` -In the case of setting the colors using RGB, 4 colors must be given in with the format: ``[R,G,B:R,G,B:R,G,B:R,G,B]``. These colors correspond to CPU art color (2 colors) and for the text colors (following 2). Thus, you can customize all the colors. +### 4.2 Specifying the colors in RGB format -# 5. Implementation +5 colors must be given in RGB with the format: ``[R,G,B:R,G,B:R,G,B:R,G,B:R,G,B]``. These colors correspond to the CPU logo color (first 3 colors) and for the text colors (following 2). + +``` +./cpufetch --color 239,90,45:210,200,200:0,0,0:100,200,45:0,200,200 +``` + +## 5. Implementation See [cpufetch programming documentation](https://github.com/Dr-Noob/cpufetch/doc/README.md). -# 6. Bugs or improvements +## 6. Bugs or improvements See [cpufetch contributing guidelines](https://github.com/Dr-Noob/cpufetch/CONTRIBUTING.md) -# 7. Acknowledgements +## 7. Acknowledgements Thanks to the fellow contributors and interested people in the project. Special thanks to: - [Gonzalocl](https://github.com/Gonzalocl), [OdnetninI](https://github.com/OdnetninI): Tested cpufetch in the earlier versions of the project in many different CPUs. - [Kyngo](https://github.com/Kyngo): Tested cpufetch in the Apple M1 CPU. - [avollmerhaus](https://github.com/avollmerhaus): Gave me ssh acess to a PowerPC machine, allowing me to develop the PowerPC port. - [bbonev](https://github.com/bbonev), [stephan-cr](https://github.com/stephan-cr): Reviewed the source code. -# 8. cpufetch for GPUs (gpufetch) +## 8. cpufetch for GPUs (gpufetch) See [gpufetch](https://github.com/Dr-Noob/gpufetch) project! diff --git a/pictures/cascade_lake.jpg b/pictures/cascade_lake.jpg new file mode 100644 index 0000000..b22f94f Binary files /dev/null and b/pictures/cascade_lake.jpg differ diff --git a/pictures/cascade_lake.png b/pictures/cascade_lake.png deleted file mode 100644 index c0caa95..0000000 Binary files a/pictures/cascade_lake.png and /dev/null differ diff --git a/pictures/epyc.png b/pictures/epyc.png index 181fc87..c48470f 100644 Binary files a/pictures/epyc.png and b/pictures/epyc.png differ diff --git a/pictures/examples.gif b/pictures/examples.gif new file mode 100644 index 0000000..952fe9c Binary files /dev/null and b/pictures/examples.gif differ diff --git a/pictures/exynos.jpg b/pictures/exynos.jpg new file mode 100644 index 0000000..1eee060 Binary files /dev/null and b/pictures/exynos.jpg differ diff --git a/pictures/exynos.png b/pictures/exynos.png deleted file mode 100644 index fd70c57..0000000 Binary files a/pictures/exynos.png and /dev/null differ diff --git a/pictures/i9.png b/pictures/i9.png index b1ac847..e089b34 100644 Binary files a/pictures/i9.png and b/pictures/i9.png differ diff --git a/pictures/ibm.png b/pictures/ibm.png new file mode 100644 index 0000000..e9efc04 Binary files /dev/null and b/pictures/ibm.png differ diff --git a/pictures/os-shield.jpg b/pictures/os-shield.jpg new file mode 100644 index 0000000..c059dd3 Binary files /dev/null and b/pictures/os-shield.jpg differ diff --git a/pictures/snapd.png b/pictures/snapd.png new file mode 100644 index 0000000..69a28ea Binary files /dev/null and b/pictures/snapd.png differ