Readme

Add support for Void Linux

Readme.md

@@ -1,20 +1,18 @@
 # fetch.sh
-### Check the releases page
-
-https://github.com/dylanaraps/fetch.sh
 
+## Big updates: Check the releases page.
 
 This is the home of my fetch script! This script gathers info <br\>
 about your system and prints it to the terminal.
 
-I've spent the past few days rewriting this and it now supports <br\>
-other distros as well as a ton of new features and bug fixes.
-
 If you're having any issues or have any ideas, please open an issue! <br\>
 I can't test on many other distros and I want this to work <br\>
 for as many people as possible.
 
-![1](https://sr.ht/5aNV.png)
+![1](https://sr.ht/Jd8Y.png)
+
+
+<!-- {{{ -->
 
 
 ## Dependencies
@@ -29,23 +27,27 @@ These are the script's optional dependencies:
 -  Image Cropping: ImageMagick
 -  Display Wallpaper: feh
 -  Current Song: mpc
+-  Resolution Detection: xorg-xdpyinfo
+
+
+<!-- }}} -->
+
+
+<!-- {{{ -->
 
 
 ## Usage
 
 The script now supports dynamic image sizing and padding,
-<br\> they're enabled by default and there's a variable you
+<br\> it's 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".
+<br\> script or launch it with ```--font_width 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.
 
@@ -58,53 +60,61 @@ Info:
 --distro string/cmd    Manually set the distro
 --kernel string/cmd    Manually set the kernel
 --uptime string/cmd    Manually set the uptime
+--uptime_shorthand on/off --v
+                       Shorten the output of uptime
 --packages string/cmd  Manually set the package count
 --shell string/cmd     Manually set the shell
 --winman string/cmd    Manually set the window manager
 --cpu string/cmd       Manually set the cpu name
 --memory string/cmd    Manually set the memory
---speed string/cmd     Manually set the cpu speed
 --speed_type           Change the type of cpu speed to get
                        Possible values: current, min, max
 --song string/cmd      Manually set the current song
 
 Text Colors:
---colors 1 2 3 4       Change the color of text
+--colors 1 2 3 4 5      Change the color of text
                        (title, subtitle, colon, info)
---titlecol num         Change the color of the title
+--title_color num      Change the color of the title
---subtitlecol num      Change the color of the subtitle
+--subtitle_color num   Change the color of the subtitle
---coloncol num         Change the color of the colons
+--colon_color num      Change the color of the colons
---infocol num          Change the color of the info
+--underline_color num  Change the color of the underline
+--info_color num       Change the color of the info
 
 Text Formatting:
---nowrap               Disable line wrapping
+--underline on/off     Enable/Disable title underline
---nobold               Disable bold text
+--underline_char char  Character to use when underlineing title
+--line_wrap on/off     Enable/Disable line wrapping
+--bold on/off          Enable/Disable bold text
 
 Color Blocks:
---printcols start end  Range of colors to print as blocks
+--color_blocks on/off  Enable/Disable the color blocks
---blockwidth num       Width of color blocks"
+--block_range start end --v
---nopal                Disable the color blocks
+                        Range of colors to print as blocks
+--block_width num       Width of 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
+--font_width px        Used to automatically size the image
---size px              Change the size of the image
+--image_position       Where to display the image: (Left/Right)
---cropoffset value     Change the crop offset. Possible values:
+--split_size num       Width of img/text splits
-                       northwest, north, northeast, west, center
+                       A value of 2 makes each split half the terminal
-                       east, southwest, south, southeast
+                       width and etc
---padding num          How many spaces to pad the text
+--crop_mode            Which crop mode to use
-                       to the right
+                       Takes the values: normal, fit, fill
+--crop_offset value    Change the crop offset for crop_mode normal.
+                       Possible values: northwest, north, northeast,
+                       west, center, east, southwest, south, southeast
 --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
+--images on/off        Enable/Disable all images
---nowall               Disable the wallpaper function
+--wall on/off          Enable/Disable the wallpaper function
                        and fallback to \$img
 --clean                Remove all cropped images
 
@@ -113,44 +123,52 @@ Other:
 ```
 
 
+<!-- }}} -->
+
+
+<!-- {{{ -->
+
+
 ## TODO
 
 Here's what's on my todo list
 
-- Add an easy way to define info prefixes at launch.
+- Uptime doesn't work in OS X yet.
-- 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
+- Windows support (I'm almost done)
-  <br/>your waifu no matter where she is in the image.
+
+- OpenBSD support (Partially implemented, just needs testing)
+
+- Imagemagick optimizations
+
+- Cleanup of info array handling
+
+- More info outputs. Now that it's easy to customize what's printed and
+  everything is a function we can add optional support for pretty much anything.
+
+    - Resolution
+    - GTK themes
+    - Terminal Font
+    - GPU
+    - IP
+    - etc
+
+<!-- }}} -->
 
 
-## Customization
+### Crop mode comparison
 
-I launch fetch using a shell function and a ton of flags. Here's how it looks:
+#### Fit
+![fit](https://imgur.com/MI0UtSV.png)
 
-```sh
+#### Fill
-fetch () {
+![fill](https://imgur.com/LvxYwki.png)
-    fetch.sh \
-        --printcols 1 7 \
-        --cpu "AMD FX-6300" \
-        --uptime "$(uptime -p | sed -e 's/minutes/mins/')" \
-        --title "dylan's pc" \
-        --nowrap \
-        --nobold \
-        $@
-}
-```
-
-Notice how you can even pass commands? This allows you to easily use custom
-<br/> commands or even just bare strings to change the info.
 
 
-## Screenshots
+### Thanks
 
-#### The color script is now builtin.
+Thanks to:
-![2](https://sr.ht/Z9hZ.png)
 
-#### You can now customize the color of everything.
+- Screenfetch: I've used some snippets as a base for a few functions in this script
-![3](https://sr.ht/hy7m.png)
 
-#### You can now disable all images with a flag.
+- @jrgz: Helping me test the Mac OS X version.
-![4](https://sr.ht/zujR.png)