From f13ea88dde681c0d2db110f2c5e957bfc704ec15 Mon Sep 17 00:00:00 2001 From: Dylan Date: Fri, 22 Jan 2016 18:04:53 +1100 Subject: [PATCH] Update docs --- README.md | 27 ++++++++++++++++----------- fetch | 13 +++++++++---- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 726fa7f7..1eaee9cf 100644 --- a/README.md +++ b/README.md @@ -60,31 +60,36 @@ https://github.com/dylanaraps/fetch/wiki/Customizing-Info ## Dependencies -#### Required dependencies: +### Required dependencies: + +**All OS:** - `Bash 4.0+` - Text formatting, dynamic image size and padding: `tput` + +**Linux / BSD / Windows:** + - Uptime detection: `procps` or `procps-ng` -#### Optional dependencies: +### Optional dependencies: -All OS: +**All OS:** - Displaying Images: `w3m` - You may also need `w3m-img` - **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`. - Image Cropping, Resizing etc: `ImageMagick` -- Current Song: `mpc` -- Resolution Detection: `xorg-xdpyinfo` - Window manager detection: `wmctrl` - 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` +- 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 # In script options -$uptime_shorthand on -$gtk_shorthand on -$gpu_shorthand on +uptime_shorthand="on" +gtk_shorthand="on" +gpu_shorthand="on" # Launch flags --uptime_shorthand on diff --git a/fetch b/fetch index 39d3d58a..6c4ab108 100755 --- a/fetch +++ b/fetch @@ -2,14 +2,19 @@ # Fetch info about your system # 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) # Displaying Images: w3m + w3m-img # 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 +# [ Linux / BSD ] Wallpaper Display: feh or nitrogen +# [ Linux / BSD ] Current Song: mpc or cmus +# [ Linux / BSD ] Resolution detection: xorg-xdpyinfo # # Created by Dylan Araps # https://github.com/dylanaraps/