docs: README
This commit is contained in:
Dylan Araps
parent
7c464938b9
commit
039a9a81a9
1 changed files with 6 additions and 53 deletions
59
README.md
59
README.md
|
|
@ -9,66 +9,23 @@
|
|||
[](https://github.com/dylanaraps/neofetch/releases)
|
||||
[](https://www.patreon.com/dyla)
|
||||
|
||||
Neofetch is a command-line system information tool written in `bash 3.2+`. Neofetch displays information about your operating system, software and hardware in an aesthetic and visually pleasing way.
|
||||
|
||||
Neofetch is a CLI system information tool written in BASH. Neofetch displays information about your system next to an image, your OS logo, or any ASCII file of your choice. The main purpose of Neofetch is to be used in screenshots to show other users what OS/Distro you're running, what Theme/Icons you're using etc.
|
||||
The information by default is displayed alongside your operating system's logo. You can further configure Neofetch to instead use an image, a custom ASCII file, your wallpaper or nothing at all.
|
||||
|
||||
Neofetch is highly customizable through the use of command line flags or the user config file. There are over 50 config options to mess around with and there's the `print_info()` function and friends which let you add your own custom info.
|
||||
You can further configure Neofetch to display exactly what you want it to. Through the use of command-line flags and the configuration file you can change existing information outputs or add your own custom ones.
|
||||
|
||||
Neofetch can be used on any OS that has BASH 3.2+, it's just a matter of adding support. If your OS/Distro isn't in the list below, feel free to open an issue on the repo and I'll gladly add support. Neofetch currently supports `Linux`, `MacOS`, `iOS`, `BSD`, `Solaris`, `Android`, `Haiku`, `GNU Hurd`, `MINIX`, `AIX`, `IRIX`, `FreeMint`, and `Windows (Cygwin/MSYS2/MinGW/Windows 10 Linux subsystem)`.
|
||||
Neofetch supports almost 150 different operating systems. From Linux to Windows, all the way to more obscure operating systems like Minix, AIX and Haiku. If your favourite operating system is unsupported: Open up an issue and support will be added.
|
||||
|
||||
For more information:
|
||||
|
||||
**https://github.com/dylanaraps/neofetch/wiki**
|
||||
[\[Dependencies\](https://github.com/dylanaraps/neofetch/wiki/Dependencies) [\[Installation\](https://github.com/dylanaraps/neofetch/wiki/Installation) [\[Wiki\](https://github.com/dylanaraps/neofetch/wiki)
|
||||
|
||||
|
||||
<img src="https://i.imgur.com/lUrkQBN.png" alt="neofetch" align="right" width="434px">
|
||||
<img src="https://i.imgur.com/GFmC5Ad.png" alt="neofetch" width="434px">
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
https://github.com/dylanaraps/neofetch/wiki/Dependencies
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
https://github.com/dylanaraps/neofetch/wiki/Installation
|
||||
|
||||
|
||||
## Post Install
|
||||
|
||||
|
||||
### Using the config file
|
||||
|
||||
Neofetch will by default create a config file at `$HOME/.config/neofetch/config` and this file contains all of the script's options/settings. The config file allows you to keep your customizations between script versions and allows you to easily share your customizations with other people.
|
||||
|
||||
You can launch the script without a config file by using the flag `--config none` and you can specify a custom config location using `--config path/to/config`.
|
||||
|
||||
See this wiki page for the default config: https://github.com/dylanaraps/neofetch/wiki/Config-File
|
||||
|
||||
|
||||
### Customizing what info gets displayed
|
||||
|
||||
https://github.com/dylanaraps/neofetch/wiki/Customizing-Info
|
||||
|
||||
|
||||
### Customizing the script using a custom alias
|
||||
|
||||
If you don't want to use the config file you can customize almost everything using launch flags.
|
||||
|
||||
Here's an example neofetch alias:
|
||||
|
||||
```sh
|
||||
alias neofetch2="neofetch \
|
||||
--config off \
|
||||
--block_range 1 8 \
|
||||
--bold off \
|
||||
--uptime_shorthand on \
|
||||
--gtk_shorthand on \
|
||||
--colors 4 1 8 8 8 7 \
|
||||
"
|
||||
```
|
||||
|
||||
|
||||
## Thanks
|
||||
|
||||
Thanks to:
|
||||
|
|
@ -86,7 +43,6 @@ Thanks to:
|
|||
- Tiny ASCII logos
|
||||
|
||||
|
||||
|
||||
## Donate
|
||||
|
||||
Donations will allow me to spend more time working on `neofetch`.
|
||||
|
|
@ -94,6 +50,3 @@ Donations will allow me to spend more time working on `neofetch`.
|
|||
If you like `neofetch` and want to give back in some way you can donate here:
|
||||
|
||||
**https://patreon.com/dyla**
|
||||
|
||||
|
||||
<sup><sub>hey rtexel</sub></sup>
|
||||
|
|
|
|||
Loading…
Reference in a new issue