Update docs

This commit is contained in:
Dylan 2016-01-22 18:04:53 +11:00
parent 7577752047
commit f13ea88dde
2 changed files with 25 additions and 15 deletions

View File

@ -60,31 +60,36 @@ https://github.com/dylanaraps/fetch/wiki/Customizing-Info
## Dependencies ## Dependencies
#### Required dependencies: ### Required dependencies:
**All OS:**
- `Bash 4.0+` - `Bash 4.0+`
- Text formatting, dynamic image size and padding: `tput` - Text formatting, dynamic image size and padding: `tput`
**Linux / BSD / Windows:**
- Uptime detection: `procps` or `procps-ng` - Uptime detection: `procps` or `procps-ng`
#### Optional dependencies: ### Optional dependencies:
All OS: **All OS:**
- Displaying Images: `w3m` - Displaying Images: `w3m`
- You may also need `w3m-img` - You may also need `w3m-img`
- **Note:** The script can now also use iTerm2's builtin image rendering instead of w3m! - **Note:** The script can now also use iTerm2's builtin image rendering instead of w3m!
- Enable it by changing `image_backend` to `iterm2` or by using the launch flag `--image_backend`. - Enable it by changing `image_backend` to `iterm2` or by using the launch flag `--image_backend`.
- Image Cropping, Resizing etc: `ImageMagick` - Image Cropping, Resizing etc: `ImageMagick`
- Current Song: `mpc`
- Resolution Detection: `xorg-xdpyinfo`
- Window manager detection: `wmctrl` - Window manager detection: `wmctrl`
- This is used as a fallback to parsing `.xinitrc` and `$XDG_CURRENT_DESKTOP`. - This is used as a fallback to parsing `.xinitrc` and `$XDG_CURRENT_DESKTOP`.
- Take a screenshot on script finish: `scrot`
- You can change this to another program with a `--scrotcmd` and an in script option.
Linux | BSD: **Linux / BSD:**
- Display Wallpaper: `feh` or `nitrogen` - Display Wallpaper: `feh` or `nitrogen`
- Current Song: `mpc` or `cmus`
- Resolution Detection: `xorg-xdpyinfo`
- Take a screenshot on script finish: `scrot`
- You can change this to another program with a `--scrotcmd` and an in script option.
<!-- }}} --> <!-- }}} -->
@ -288,9 +293,9 @@ There are a few ways to fix this.
```sh ```sh
# In script options # In script options
$uptime_shorthand on uptime_shorthand="on"
$gtk_shorthand on gtk_shorthand="on"
$gpu_shorthand on gpu_shorthand="on"
# Launch flags # Launch flags
--uptime_shorthand on --uptime_shorthand on

13
fetch
View File

@ -2,14 +2,19 @@
# Fetch info about your system # Fetch info about your system
# https://github.com/dylanaraps/fetch # https://github.com/dylanaraps/fetch
# #
# Required Dependencies:
# Bash 4.0+
# Text formatting, dynamic image size and padding: tput
# [Linux / BSD / Windows] Uptime detection: procps or procps-ng
#
#
# Optional Dependencies: (You'll lose these features without them) # Optional Dependencies: (You'll lose these features without them)
# Displaying Images: w3m + w3m-img # Displaying Images: w3m + w3m-img
# Image Cropping: ImageMagick # Image Cropping: ImageMagick
# Wallpaper Display: feh
# Current Song: mpc
# Text formatting, dynamic image size and padding: tput
# Resolution detection: xorg-xdpyinfo
# More accurate window manager detection: wmctrl # More accurate window manager detection: wmctrl
# [ Linux / BSD ] Wallpaper Display: feh or nitrogen
# [ Linux / BSD ] Current Song: mpc or cmus
# [ Linux / BSD ] Resolution detection: xorg-xdpyinfo
# #
# Created by Dylan Araps # Created by Dylan Araps
# https://github.com/dylanaraps/ # https://github.com/dylanaraps/