thelilfrog/cpufetch
1
0
Fork 0
mirror of https://github.com/Dr-Noob/cpufetch.git synced 2026-03-25 07:50:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Dr-Noob
2020-12-25 15:42:33 +01:00
parent fce0bbf012
commit c7d1165a94
4 changed files with 110 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -1,25 +1,16 @@
# cpufetch
Simplistic yet fancy CPU architecture fetching tool
![cpu1](pictures/i9.png)
![cpu1](i9.png)
### Platforms
cpufetch currently supports x86_64 CPUs (both Intel and AMD) and ARM (experimental support)
| Platform | Intel | AMD | ARM | Notes |
|:---------:|:-------------------------:|:------------------------:|:------------------------:|:-----------------:|
| Linux | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Prefered platform. <br> Experimental ARM support |
| Windows | :heavy_check_mark: | :heavy_check_mark: | :x: | Some information may be missing. <br> Colors will be used if supported |
| Android | :heavy_exclamation_mark: | :heavy_exclamation_mark: | :heavy_check_mark: | Experimental ARM support |
| macOS | :heavy_exclamation_mark: | :heavy_exclamation_mark: | :heavy_exclamation_mark: | Untested |
| Emoji | Meaning |
|:-----------------------:|:-------------:|
|:heavy_check_mark: | Supported |
|:x: | Not Supported |
|:heavy_exclamation_mark: | Unested |
cpufetch currently supports x86 CPUs (both Intel and AMD CPUs)
| Platform | Intel | AMD | Notes |
|:---------:|:-------------------------:|:------------------------:|:-----------------:|
| Linux | :heavy_check_mark: | :heavy_check_mark: | Prefered platform |
| Windows | :heavy_check_mark: | :heavy_check_mark: | Some information may be missing. <br> Colors will be used if supported |
| macOS | :heavy_exclamation_mark: | :heavy_exclamation_mark: | Untested |
### Usage and installation
@@ -31,11 +22,9 @@ If you are in other distro, you can build `cpufetch` from source (see below)
#### Windows
In the [releases](https://github.com/Dr-Noob/cpufetch/releases) section you will find some cpufetch executables compiled for Windows. Just download and run it from Windows CMD.
#### Android
You need to build `cpufetch` from source (see below).
#### Building from source
Just clone the repo and use `make` to compile it
### Building from source
#### Linux and Windows
```
git clone https://github.com/Dr-Noob/cpufetch
cd cpufetch
@@ -43,24 +32,15 @@ make
./cpufetch
```
#### Android
I recommend using `termux` terminal emulator. Once you installed it, run the following commands:
The Makefile is designed to work on both Linux and Windows.
```
pkg install -y git make clang
git clone https://github.com/Dr-Noob/cpufetch
cd cpufetch
make
./cpufetch
```
### Examples
### Example
Here are more examples of how `cpufetch` looks on different CPUs.
![cpu2](pictures/epyc.png)
![cpu2](epyc.png)
![cpu3](pictures/cascade_lake.png)
![cpu3](cascade_lake.png)
### 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
@@ -76,10 +56,10 @@ In the case of setting the colors using RGB, 4 colors must be given in with the
### Implementation
`cpufetch` fetches all of the information using the `CPUID` x86 instruction. There are, however, some cases where the CPU does not support fetching some needed information. In this case, `cpufetch` will use `/sys/devices/system/cpu` in Linux as a fallback. If `cpufetch` is running on Windows and `CPUID` does not give all the data, `cpufetch` won't be able to show it. [I hope this can be fixed in the future](https://github.com/Dr-Noob/cpufetch/issues/30)
See [cpufetch programming documentation](https://github.com/Dr-Noob/cpufetch/blob/master/doc/README.md).
### Bugs or improvements
There are many open issues in github (see [issues](https://github.com/Dr-Noob/cpufetch/issues)). Feel free to open a new one report a issue or propose any improvement in `cpufetch`
### Testers
I would like to thank [Gonzalocl](https://github.com/Gonzalocl) and [OdnetninI](https://github.com/OdnetninI) for their help, running `cpufeth` in many different CPUs they have access to, which makes it easier to debug and check the correctness of `cpufetch`.
I would like to thank [Gonzalocl](https://github.com/Gonzalocl) and [OdnetninI](https://github.com/OdnetninI) for their help, running `cpufetch` in many different CPUs they have access to, which makes it easier to debug and check the correctness of `cpufetch`.