diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 49 insertions, 1 deletions
@@ -1,4 +1,52 @@ xboomx ====== -xboomx is wrapper around the dmenu. It is also a launcher +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 |