Big update, check the releases page

This commit is contained in:
dylan araps 2015-12-31 11:21:10 +11:00
parent 148ec7a190
commit 4f4e6edd71
2 changed files with 206 additions and 140 deletions

View file

@ -1,4 +1,5 @@
# fetch.sh
### Check the releases page
https://github.com/dylanaraps/fetch.sh
@ -18,24 +19,35 @@ for as many people as possible.
## Dependencies
These are the script's dependencies:
These are the script's required dependencies
- Text formatting, dynamic image size and padding: tput
These are the script's optional dependencies:
- Displaying Images: w3m
- Image Cropping: ImageMagick
- Display Wallpaper: feh
- Current Song: mpc
These are the script's optional dependencies
- Window Manager Detection: wmctrl
- You can manually set this at launch with:
```sh
scrot.sh --winman string
```
## Usage
The whitespace
The script now supports dynamic image sizing and padding,
<br\> they're enabled by default and there's a variable you
<br\> need to set for it to work correctly.
You can either change the variable $fontwidth inside of the
<br\> script or launch it with "--fontwidth num".
Once you set the var the script will scale the image and padding
<br\> to fit your terminal window.
You can disable this by changing the var "$img_auto" or by launching
<br\> the script with "--size px".
Please report any bugs or issues you're having with this as I can't
<br\> test with many configurations.
```
@ -64,24 +76,33 @@ Text Colors:
--coloncol num Change the color of the colons
--infocol num Change the color of the info
Text Formatting:
--nowrap Disable line wrapping
--nobold Disable bold text
Color Blocks:
--printcols start end Range of colors to print as blocks
--blockwidth num Width of color blocks"
--nopal Disable the color blocks
Image:
--image Image to display with the script
The image gets priority over other
images: (wallpaper, \$img)
--fontwidth Used to automatically size the image
--size px Change the size of the image
--cropoffset value Change the crop offset. Possible values:
northwest, north, northeast, west, center
east, southwest, south, southeast
--padding How many spaces to pad the text
--padding num How many spaces to pad the text
to the right
--xoffset px How close the image will be
to the left edge of the window
--yoffset px How close the image will be
to the top edge of the window
--gap num Gap between image and text right side
--noimg Disable all images
--nowall Disable the wallpaper function
and fallback to \$img
@ -97,11 +118,9 @@ Other:
Here's what's on my todo list
- Add an easy way to define info prefixes at launch.
- Find a reliable way to set the text padding dynamically. I can get this to
<br/> work based on font width but there's no reliable way of getting
<br/> fontwidth for every terminal afaik.
If you've got any ideas on how to solve these problems, let me know!
- Finish adding an option to smart crop images with plain color backgrounds.
<br/>What this means is that your solid bg waifu wallpaper will be cropped around
<br/>your waifu no matter where she is in the image.
## Customization
@ -113,9 +132,10 @@ fetch () {
fetch.sh \
--printcols 1 7 \
--cpu "AMD FX-6300" \
--song "$(mpc current | cut -c 1-30)" \
--uptime "$(uptime -p | sed -e 's/minutes/mins/')" \
--title "dylan's pc" \
--nowrap \
--nobold \
$@
}
```