Browse Source

Standardized readme and added more detailed install instructions.

Dalton Nell 9 years ago
parent
commit
be060e70e1
1 changed files with 19 additions and 13 deletions
  1. 19
    13
      README.md

+ 19
- 13
README.md View File

@@ -1,10 +1,8 @@
1
-slop
2
-====
1
+# slop
3 2
 
4 3
 slop (Select Operation) is an application that querys for a selection from the user and prints the region to stdout. It grabs the mouse and turns it into a crosshair, lets the user click and drag to make a selection (or click on a window) while drawing a pretty box around it, then finally prints the selection's dimensions to stdout.
5 4
 
6
-features
7
---------
5
+## Features
8 6
 * Hovering over a window will cause a selection rectangle to appear over it.
9 7
 * Clicking on a window makes slop return the dimensions of the window.
10 8
 * Clicking and dragging causes a selection rectangle to appear, renders pretty well (compared to scrot). And will return the dimensions of that rectangle in absolute screen coords.
@@ -17,8 +15,7 @@ features
17 15
     * Set the color of the selection rectangles to match your theme! (Even supports transparency!)
18 16
     * Remove window decorations from selections.
19 17
 
20
-practical applications
21
-----------------------
18
+## Practical applications
22 19
 slop can be used to create a video recording script in only two lines of code.
23 20
 ```bash
24 21
 #!/bin/bash
@@ -39,8 +36,7 @@ If you don't like ImageMagick's import: Check out [maim](https://github.com/nael
39 36
 You can see my implementation of slop in a screenshooter here:
40 37
 https://gist.github.com/naelstrof/6530959
41 38
 
42
-lets see some action
43
---------------------
39
+## Lets see some action
44 40
 Ok. Here's a comparison between 'scrot -s's selection and slop's:
45 41
 ![scrotbad](http://farmpolice.com/content/images/2014-10-14-12:08:24.png)
46 42
 ![slopgood](http://farmpolice.com/content/images/2014-10-14-12:14:51.png)
@@ -48,20 +44,30 @@ Ok. Here's a comparison between 'scrot -s's selection and slop's:
48 44
 You can see scrot leaves garbage lines over the things you're trying to screenshot!
49 45
 While slop not only looks nicer, it's impossible for it to end up in screenshots or recordings because it waits for DestroyNotify events before completely shutting down. Only after the window is completely destroyed can anything take a screenshot.
50 46
 
51
-how to install
52
---------------
53
-You really should use your package manager when possible, you never know what kind of garbage applications will dump everywhere. For example you can install slop on Arch Linux by installing it from the AUR: [slop-git](https://aur.archlinux.org/packages/slop-git/).
47
+## how to install
48
+
49
+### Install using your Package Manager (preferred)
50
+
51
+* [Arch Linux AUR (slop-git)](https://aur.archlinux.org/packages/slop-git/)
52
+* Please make a package for slop on your favorite system, and make a pull request to add it to this list.
53
+
54
+
55
+### Install using Make
56
+
57
+Note: Dependencies should be installed first: libXext, and glibc.
54 58
 
55
-However slop just installs a single binary to /usr/bin. If that's ok with you-- you can install it with:
56 59
 ```bash
60
+git clone https://github.com/naelstrof/slop.git
61
+cd slop
57 62
 make && sudo make install
58 63
 ```
64
+
59 65
 Make sure to check out and install [maim](https://github.com/naelstrof/maim) too if you want a proper screenshot utility.
60 66
 
61 67
 help
62 68
 ----
63 69
 ```text
64
-slop v3.1.3
70
+slop v3.1.4
65 71
 
66 72
 Copyright (C) 2014 Dalton Nell, GPLv3
67 73