浏览代码

Updated README.md

Dalton Nell 9 年前
父节点
当前提交
6e2428c9e0
共有 1 个文件被更改,包括 49 次插入2 次删除
  1. 49
    2
      README.md

+ 49
- 2
README.md 查看文件

@@ -14,6 +14,10 @@ slop (Select Operation) is an application that querys for a selection from the u
14 14
     * Set click tolerance for if you have a shaky mouse.
15 15
     * Set the color of the selection rectangles to match your theme! (Even supports transparency!)
16 16
     * Remove window decorations from selections.
17
+* Supports OpenGL hardware acceleration.
18
+* Supports textured themes.
19
+* Supports programmable shaders.
20
+* Supports a magnifying glass.
17 21
 
18 22
 ## Practical applications
19 23
 slop can be used to create a video recording script in only two lines of code.
@@ -73,17 +77,47 @@ While slop not only looks nicer, it's impossible for it to end up in screenshots
73 77
 
74 78
 ### Install using CMake (Requires CMake)
75 79
 
76
-Note: Dependencies should be installed first: libXext.
80
+*Note: Dependencies should be installed first: libxext, imlib2, mesa, libxrender, libxrandr, and glew.*
77 81
 
78 82
 ```bash
79 83
 git clone https://github.com/naelstrof/slop.git
80 84
 cd slop
81
-cmake ./
85
+cmake -DCMAKE_OPENGL_SUPPORT=true ./
82 86
 make && sudo make install
83 87
 ```
84 88
 
85 89
 Make sure to check out and install [maim](https://github.com/naelstrof/maim) too if you want a proper screenshot utility.
86 90
 
91
+## Configuration
92
+Ever since slop had OpenGL support, it now has quite a few customizations that can be done.
93
+
94
+*Note: Configuration directories are located at __${XDG\_CONFIG\_HOME}/slop__ or __${CMAKE\_INSTALL\_PREFIX}/share/slop__, whichever comes first. These will be refferred to as __~/.config/slop__ and __/usr/share/slop__ respectively from here on.*
95
+
96
+### Shaders
97
+[![Demo Shaders](http://farmpolice.com/content/images/slop_demo.gif)](http://farmpolice.com/content/videos/8a5c37c4.webm)
98
+
99
+*Click for video*
100
+
101
+Slop supports shaders that are loaded from the configuration directories.
102
+They're all completely programmable, but they do lack some features like chaining right now.
103
+To configure the shaders or create your own, first copy the global configuration folder to your ~/.config folder like so:
104
+```bash
105
+cp -r /usr/share/slop ~/.config
106
+```
107
+Then edit or add new shaders at ~/.config/slop as if you were editing the originals, slop will reflect the changes on restart.
108
+If there's any missing features in the shaders: don't hesitate to make an issue to request them, and feel free to make your own shaders and submit a pull request to see if it can be officially included!
109
+
110
+### Themes
111
+![Demo Themes](http://farmpolice.com/content/images/1436653680.png)
112
+Slop has primitive support for texture themes, I've included a poorly made *gothic* theme that you can test with `slop --opengl --theme gothic`.
113
+To create your own you'll have to copy the configuration directory, just like with the shaders above, like so:
114
+```bash
115
+cp -r /usr/share/slop ~/.config
116
+```
117
+The theme names are taken from the folder names, the files inside represent the corresponding textures. For example *~/config/gothic/corner\_tr.png* would correspond to the top right square texture in a gothic themed selection.
118
+The theming is still missing offset configuration, and is quite limiting in design. Themes probably won't be flushed out further unless someone makes an issue to request more features.
119
+Feel free to make your own themes and submit a pull request to see if it can be officially included!
120
+
87 121
 help
88 122
 ----
89 123
 ```text
@@ -137,6 +171,19 @@ Options
137 171
       --opengl                  Enable hardware acceleration. Only works with
138 172
                                   modern systems that are also running a
139 173
                                   compositor.  (default=off)
174
+      --magnify                 Display a magnifying glass when --opengl is
175
+                                  also enabled.  (default=off)
176
+      --magstrength=FLOAT       Sets how many times the magnification window
177
+                                  size is multiplied.  (default=`4')
178
+      --magpixels=INT           Sets how many pixels are displayed in the
179
+                                  magnification. The less pixels the bigger the
180
+                                  magnification.  (default=`64')
181
+      --theme=STRING            Sets the theme of the selection, using textures
182
+                                  from ~/.config/slop/ or /usr/share/.
183
+                                  (default=`none')
184
+      --shader=STRING           Sets the shader to load and use from
185
+                                  ~/.config/slop/ or /usr/share/.
186
+                                  (default=`simple')
140 187
   -f, --format=STRING           Set the output format string. Format specifiers
141 188
                                   are %x, %y, %w, %h, %i, %g, and %c.
142 189
                                   (default=`X=%x\nY=%y\nW=%w\nH=%h\nG=%g\nID=%i\nCancel=%c\n')