aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVictor Häggqvist <[email protected]>2014-09-02 22:25:33 +0200
committerVictor Häggqvist <[email protected]>2014-09-02 22:25:33 +0200
commit1958c3c47cb5a25e8258961c5784e4bfffc65ff8 (patch)
tree669c598ecf54b0dfc6c7c9abe8ccc420ed1fce0b /README.md
parentbcbd5bb12b3a1f89948d21a7a9bc0f056db73f38 (diff)
parentb0d8f2c999236474d0101819b8ec5dc514b73ccf (diff)
licnse merge
Conflicts: LICENSE
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5749f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+xboomx
+======
+
+xboomx is wrapper around the dmenu. It is also a launcher. All the things it done is just sorting commands to launch according to their launch frequency. In other words - if you launch emacs and lxterminal all the time - they will appear in the list of commands first.
+
+#Installation
+```sh
+git clone https://github.com/victorhaggqvist/xboomx
+cd xboomx
+sudo apt-get install suckless-tools # here is instrtuction for debian. really we need only dmenu
+sudo python setup.py install
+mkdir ~/.xboomx
+cp etc/config ~/.xboomx/config
+```
+
+#Config
+The config file, which if you followed the instructions above is located at `~/.xboomx/config`, contains the following a json object.
+```json
+{
+ "dmenu_params": "-b -i -nb black -nf orange -sb black -p \"#\"",
+ "ignorelist": ["X"]
+}
+```
+
+For `dmenu_params` please see the manpages for dmenu.
+```sh
+man dmenu
+```
+
+The `ignorelist` to prevent stuff that is in your path for showing up as suggestions. Like if you type `x` then `X` might show up before `xbmc`.
+
+#License
+ xboomx
+ Copyright (C) 2014 Victor Häggqvist
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+For original license see the file`LICENSE.org`
+
+This is a fork of https://bitbucket.org/dehun/xboomx