README.md
1<p align="center"><img width=50% src="./pictures/cpufetch.png"></p>
2
3<div align="center">
4
5
6[](https://github.com/Dr-Noob/cpufetch/stargazers)
7[](https://github.com/Dr-Noob/cpufetch/issues)
8[](https://repology.org/project/cpufetch/versions)
9[](https://github.com/Dr-Noob/cpufetch/blob/master/LICENSE)
10
11<h4 align="center">Simple yet fancy CPU architecture fetching tool</h4>
12
13
14
15
16</div>
17
18# Table of contents
19<!-- UPDATE with: doctoc --notitle README.md -->
20<!-- START doctoc generated TOC please keep comment here to allow auto update -->
21<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
22
23
24- [1. Support](#1-support)
25- [2. Installation](#2-installation)
26 - [2.1 Installing from a package](#21-installing-from-a-package)
27 - [2.2 Building from source (Linux/Windows/macOS)](#22-building-from-source-linuxwindowsmacos)
28 - [2.3 Android](#23-android)
29- [3. Examples](#3-examples)
30 - [3.1 x86_64 CPUs](#31-x86_64-cpus)
31 - [3.2 ARM CPUs](#32-arm-cpus)
32- [4. Colors and style](#4-colors-and-style)
33- [5. Implementation](#5-implementation)
34- [6. Bugs or improvements](#6-bugs-or-improvements)
35- [7. Acknowledgements](#7-acknowledgements)
36- [8. cpufetch for GPUs (gpufetch)](#8-cpufetch-for-gpus-gpufetch)
37
38<!-- END doctoc generated TOC please keep comment here to allow auto update -->
39
40# 1. Support
41
42cpufetch supports the following architectures:
43- x86 / x86_64
44- ARM
45- PowerPC
46
47| OS | x86_64 / x86 | ARM | PowerPC | Notes |
48|:---------:|:------------------:|:------------------:|:------------------:|:-----------------:|
49| GNU/Linux | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Best support |
50| Windows | :heavy_check_mark: | :x: | :x: | Some information may be missing. <br> Colors will be used if supported |
51| Android | :heavy_check_mark: | :heavy_check_mark: | :x: | Some information may be missing |
52| macOS | :heavy_check_mark: | :heavy_check_mark: | :x: | Only the Apple M1 is supported in ARM |
53| FreeBSD | :heavy_check_mark: | :x: | :x: | Some information may be missing. |
54
55# 2. Installation
56## 2.1 Installing from a package
57Choose the right package for your operating system:
58
59[](https://repology.org/project/cpufetch/versions)
60
61If 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).
62
63## 2.2 Building from source (Linux/Windows/macOS)
64You will need a C compiler (e.g, `gcc`), and `make` to compile `cpufetch`. To do so, just clone the repo and run `make`:
65
66```
67git clone https://github.com/Dr-Noob/cpufetch
68cd cpufetch
69make
70./cpufetch
71```
72
73The Makefile is designed to work on Linux, Windows and macOS.
74
75## 2.3 Android
761. Install `termux` app (terminal emulator)
772. Run `pkg install -y git make clang` inside termux.
783. Build from source normally:
79 - git clone https://github.com/Dr-Noob/cpufetch
80 - cd cpufetch
81 - make
82 - ./cpufetch
83
84# 3. Examples
85Here are more examples of how `cpufetch` looks on different CPUs.
86
87## 3.1 x86_64 CPUs
88
89
90
91
92
93## 3.2 ARM CPUs
94
95
96
97
98
99# 4. Colors and style
100By default, `cpufetch` will print the CPU art with the system colorscheme. However, you can always set a custom color scheme, either
101specifying Intel or AMD, or specifying the colors in RGB format:
102
103```
104./cpufetch --color intel (default color for Intel)
105./cpufetch --color amd (default color for AMD)
106./cpufetch --color 239,90,45:210,200,200:100,200,45:0,200,200 (example)
107```
108
109In 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.
110
111# 5. Implementation
112See [cpufetch programming documentation](https://github.com/Dr-Noob/cpufetch/doc/README.md).
113
114# 6. Bugs or improvements
115See [cpufetch contributing guidelines](https://github.com/Dr-Noob/cpufetch/CONTRIBUTING.md)
116
117# 7. Acknowledgements
118Thanks to the fellow contributors and interested people in the project. Special thanks to:
119- [Gonzalocl](https://github.com/Gonzalocl), [OdnetninI](https://github.com/OdnetninI): Tested cpufetch in the earlier versions of the project in many different CPUs.
120- [Kyngo](https://github.com/Kyngo): Tested cpufetch in the Apple M1 CPU.
121- [avollmerhaus](https://github.com/avollmerhaus): Gave me ssh acess to a PowerPC machine, allowing me to develop the PowerPC port.
122- [bbonev](https://github.com/bbonev), [stephan-cr](https://github.com/stephan-cr): Reviewed the source code.
123
124# 8. cpufetch for GPUs (gpufetch)
125See [gpufetch](https://github.com/Dr-Noob/gpufetch) project!
126
){kind=link}
){kind=link}
