119 lines
3.6 KiB
Markdown
119 lines
3.6 KiB
Markdown
Lemonbuddy
|
|
==========
|
|
|
|
A fast and easy-to-use tool for [Lemonbar](https://github.com/LemonBoy/bar/).
|
|
|
|
**Lemonbuddy** aims to help users build beautiful and highly customizable status bars
|
|
without messing with named pipes, MacGyver-like scripting or non-blocking
|
|
loops lobotomizing your CPU.
|
|
|
|
Please note that the project hasn't been tested, other then by myself, so
|
|
bugs and various bumps is to be expected. Please report any issues here on
|
|
github.
|
|
|
|
|
|
## Installation
|
|
|
|
### Arch Linux
|
|
Install the AUR package `lemonbuddy`
|
|
|
|
### Void Linux
|
|
A package will be written for XBPS so stay tuned.
|
|
|
|
### Dependencies:
|
|
|
|
A C++ compiler with C++14 support. For example `clang`.
|
|
|
|
- lemonbar (obviously)
|
|
- NOTE: The application has only been tested against the `single-mon` fork.
|
|
If you have trouble with your version of lemonbar, install the fork which is
|
|
included in the `contrib` folder.
|
|
|
|
There are plans to integrate `lemonbar` into the project.
|
|
- cmake
|
|
- boost
|
|
- libx11
|
|
- libxrandr
|
|
- wireless_tools _(optional: used by the network module)_
|
|
- alsa-lib _(optional: used by the volume module)_
|
|
- libmpdclient _(optional: used by the mpd module)_
|
|
- libsigc++ _(optional: used by the i3 module)_
|
|
|
|
**Installing using pacman:**
|
|
~~~ sh
|
|
$ pacman -S cmake boost libx11 libxrandr wireless_tools alsa-lib libmpdclient libsigc++ i3-wm
|
|
~~~
|
|
|
|
**Installing using xbps-install:**
|
|
~~~ sh
|
|
$ xbps-install -S cmake alsa-lib-devel boost-devel i3-devel libX11-devel libXrandr-devel libmpdclient-devel libsigc++-devel wireless_tools-devel
|
|
~~~~
|
|
|
|
**Installing using apt-get:**
|
|
|
|
> NOTE: `libmpdclient-dev` is located in the `universe` repository, so make sure it's
|
|
> included in the list of sources in `/etc/apt/sources.list`, for example:
|
|
>
|
|
> `deb http://archive.ubuntu.com/ubuntu/ xenial main restricted universe`
|
|
|
|
~~~ sh
|
|
$ apt-get install cmake libx11-dev libxrandr-dev libboost-dev libiw-dev libmpdclient-dev libsigc++-dev i3-wm
|
|
~~~~
|
|
|
|
|
|
<br>
|
|
|
|
## Building from source
|
|
|
|
#### Automatic installation using ./build.sh
|
|
|
|
If you haven't worked with builds before you could try to run the following
|
|
command chain:
|
|
|
|
~~~ sh
|
|
$ git clone --branch 0.1.1 --recursive https://github.com/jaagr/lemonbuddy.git
|
|
$ cd lemonbuddy
|
|
$ ./build.sh
|
|
~~~
|
|
|
|
NOTE: **git-perl** is required for submodules to work in **Void Linux**
|
|
|
|
---
|
|
|
|
#### It is of course recommended that you control the build process yourself.
|
|
|
|
~~~ sh
|
|
$ git clone --branch 0.1.1 --recursive https://github.com/jaagr/lemonbuddy.git
|
|
$ mkdir lemonbuddy/build
|
|
$ cd lemonbuddy/build
|
|
$ cmake ..
|
|
# List and edit build variables
|
|
$ make edit_cache
|
|
$ sudo make install
|
|
~~~
|
|
---
|
|
|
|
<br>
|
|
|
|
## License
|
|
|
|
> The MIT License (MIT)
|
|
> Copyright (c) 2016 Michael Carlberg
|
|
>
|
|
> Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
> this software and associated documentation files (the "Software"), to deal in
|
|
> the Software without restriction, including without limitation the rights to
|
|
> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
> the Software, and to permit persons to whom the Software is furnished to do so,
|
|
> subject to the following conditions:
|
|
>
|
|
> The above copyright notice and this permission notice shall be included in all
|
|
> copies or substantial portions of the Software.
|
|
>
|
|
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
> FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
> COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
> IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|