Update README.md

This commit is contained in:
Dylan Araps 2016-11-12 20:59:59 +11:00 committed by GitHub
parent 6702c84979
commit e883aae47d

117
README.md
View file

@ -24,122 +24,7 @@ Have a look at the wiki, I've updated/added some new pages!<br \>
## Dependencies ## Dependencies
- [Required dependencies](https://github.com/dylanaraps/neofetch#required-dependencies) https://github.com/dylanaraps/neofetch/wiki/Dependencies
- [Image mode dependencies](https://github.com/dylanaraps/neofetch#image-mode-dependencies)
- [Optional dependencies](https://github.com/dylanaraps/neofetch#optional-dependencies)
- [Song](https://github.com/dylanaraps/neofetch#song)
- [Desktop Environment and Window Manager](https://github.com/dylanaraps/neofetch#desktop-environment-and-window-manager)
- [Wallpaper](https://github.com/dylanaraps/neofetch#wallpaper)
- [Resolution](https://github.com/dylanaraps/neofetch#resolution)
- [Screenshot](https://github.com/dylanaraps/neofetch#screenshot)
- [GPU](https://github.com/dylanaraps/neofetch#gpu)
- [iOS dependencies](https://github.com/dylanaraps/neofetch#ios)
- [Android dependencies](#android)
### Required dependencies:
- `Bash 3.0+`
- Alpine Linux: You also need `ncurses`.
### Image mode dependencies:
These dependencies are required for image mode to work.
- Displaying images: `w3m-img` \[1\] or `iTerm2` or `Terminology` \[2\]
- Thumbnail creation: `imagemagick`
- Window size: A terminal emulator that supports `\033[14t` \[3\] or `xdotool` or `xwininfo + xprop` or `xwininfo + xdpyinfo`
\[1\] `w3m-img` is sometimes bundled together with `w3m`.
\[2\] Image support is built into Terminology and iTerm2, and doesn't require w3m-img.
\[3\] See this wiki page to find out if your terminal emulator supports `\033[14t` or if you need an additonal dependency.
### Optional dependencies:
#### Song
- Google Play Music Desktop Player: [`gpmdp-remote`](https://github.com/iAndrewT/gpmdp-remote)
- MPD: `mpc`
- CMUS: `cmus`
- MOC: `moc`
- Spotify: `spotify`
- Rhythmbox: `rhythmbox`
- Banshee: `banshee`
- Amarok: `amarok`
- Deadbeef: `deadbeef`
#### Desktop Environment and Window Manager
- Desktop Environment and Window Manager: `xprop` \[1\]
\[1\] See **[#79](https://github.com/dylanaraps/neofetch/issues/79)** about why this is now a required dependency.
#### Wallpaper
**Linux, BSD and Solaris**
- Wallpaper: `feh`, `nitrogen` or `gsettings`
**Windows and macOS**
- No additional dependencies needed.
#### Resolution
**Linux, BSD and Solaris**
- Resolution: `xorg-xrandr` or `xorg-xdpyinfo` \[1\]
**macOS**
- Resolution (quicker): `screenresolution` \[2\]
\[1\] Xrandr is prefered over xdpyinfo as Xrandr supports multi monitor and refresh rate display in the<br \>
output.
\[2\] `screenresolution` is installed for you when using homebrew.
#### Screenshot
- Screenshot: `scrot` \[1\]
\[1\] You can use the launch flag `--scrot_cmd` or change the config option `$scrot_cmd` to your screenshot<br \>
program's cmd and neofetch will use it instead of scrot.
#### GPU
**BSD and Solaris**
- GPU: `glxinfo`
- Not required on FreeBSD.
#### iOS
These dependencies can all be installed through Cydia.<br \>
Note: The cydia package installs these dependencies for you.
- `Bourne-Again SHell`
- `Core Utilities`
- `Core Utilities (/bin)`
- `Darwin Tools`
- `system-cmds`
- `Gawk`
- `grep`
#### Android
- `bash`
- `busybox`
Note: I recommend installing `termux` from the Play Store or F-Droid. Termux provides you with a fully working Linux environment, doesn't require root acess and includes all dependencies.
Note2: Neofetch is in Termux's official repos.
## Installation ## Installation