README.md 2.77 KB
Newer Older
Popi's avatar
Popi committed
1
# conky-grapes
Popi's avatar
Popi committed
2

Popi's avatar
Popi committed
3
4
![](https://pic.nomagic.uk/R9WuT0MJ)

kohl42's avatar
kohl42 committed
5
6
**The Github repository is only a mirror, only for visibility purppose.** I use GitLab CE for my own projects (which now has mirroring feature on Community Edition).

popi's avatar
popi committed
7
You can authenticate on [my gitlab server](https://gitlab.nomagic.uk/popi/conky-grapes) using your Github or Gitlab account to submit issues or merge requests.
kohl42's avatar
kohl42 committed
8
9

### Updates
10
- 2018-07-22: changed option `--arch` to `--old` with reverse meaning, so that by default we create config for freetype >= 2.8.
kohl42's avatar
kohl42 committed
11
12
13
- 2018-04-04: tagging first stable as reference.
- 2018-01-28: Activating mirror between gitlab and github for this project. Also latest updates should allow the script to work on gnome-shell (though there might still be shome issues).
- 2017-08-13: New io_wait ring! Due to the nature of io_wait monitoring in conky, I reversed display for this one. In the middle you will see average values for reads and writes and the rigns will show the 3 processes using most IO.
Popi's avatar
Popi committed
14
It's not perfect, but it can point out which process is creating a bottleneck.
kohl42's avatar
kohl42 committed
15

Popi's avatar
Popi committed
16
## What is it
Popi's avatar
Popi committed
17
18
19
This repository aims at providing you everything you need to be able to **very quickly** build a fantastic grape-shaped lua/ conky adapted to your machine including:
* Metrics on temperature, cpu (maximum fixed to 8 cpu to display), disks (maximum 3 filesystem), memory (ram and swap), networking (we select the interface used as default gateway),
and battery when relevant.
Popi's avatar
Popi committed
20
* Visual monitoring for high temperature, low disk space and low battery charge (orange is warning, red is critical)
Popi's avatar
Popi committed
21
22
* A set of pre-defined colours that allows to easily adapt your settings to different backgrounds (colors can be added/ changed in the python file fairly easily).
* Possibility to select different colors for the rings, the section titles, and the text.
Popi's avatar
Popi committed
23

Popi's avatar
Popi committed
24
25
_note: the limits on cpu and filesystems are for display reason._

Popi's avatar
Popi committed
26
![](https://pic.nomagic.uk/W9MjLPJF)
Popi's avatar
Popi committed
27
28

## Why use it
kohl42's avatar
kohl42 committed
29
To tune up your desktop of course! It is under [GPLv3 License](gpl-3.0.txt), so feel free to use, study, improve and share as you please.
Popi's avatar
Popi committed
30
31
32
33


## How to use it
* If you already know your way around, all you need is:
Popi's avatar
Popi committed
34
35
36
  - install conky-full
  - clone this repo to ~/conky/conky-grapes
  - install the fonts
popi's avatar
popi committed
37
  - use `create_config.py` to generate your configuration (use `-h` to display help)
Popi's avatar
Popi committed
38
  - enjoy color combinations and spend a fairly big amount of time looking at those magic rings
Popi's avatar
Popi committed
39
40
41
42
43
44
45
46
47
48
49
50

```
 -----------------------------
< ALL GLORY TO THE HYPNOTOAD! >
 -----------------------------
        \   ^__^
         \  (@@)\_______
            (__)\       )\/\
             U ||----w |
                ||     ||
```

kohl42's avatar
kohl42 committed
51
* If you haven't used or set up any conky before, please go to the [Wiki](https://gitlab.nomagic.fr/popi/conky-grapes/wikis/home) page (that you can also edit with your inputs!)