tint2/README.md
2017-09-08 18:08:28 +02:00

100 lines
4.2 KiB
Markdown

# Latest stable release: 15.1
Changes: https://gitlab.com/o9000/tint2/blob/15.1/ChangeLog
Documentation: [doc/tint2.md](doc/tint2.md)
Compile it with (after you install the [dependencies](https://gitlab.com/o9000/tint2/wikis/Install#dependencies)):
```
git clone https://gitlab.com/o9000/tint2.git
cd tint2
git checkout 15.1
mkdir build
cd build
cmake ..
make -j4
```
To install, run (as root):
```
make install
update-icon-caches /usr/local/share/icons/hicolor
update-mime-database /usr/local/share/mime
```
And then you can run the panel `tint2` and the configuration program `tint2conf`.
Please report any problems to https://gitlab.com/o9000/tint2/issues. Your feedback is much appreciated.
P.S. GitLab is now the official location of the tint2 project, migrated from Google Code, which is shutting down. In case you are wondering why not GitHub, BitBucket etc., we chose GitLab because it is open source, it is mature and works well, looks cool and has a very nice team.
# What is tint2?
tint2 is a simple panel/taskbar made for modern X window managers. It was specifically made for Openbox but it should also work with other window managers (GNOME, KDE, XFCE etc.). It is based on ttm https://code.google.com/p/ttm/.
# Features
* Panel with taskbar, system tray, clock and launcher icons;
* Easy to customize: color/transparency on fonts, icons, borders and backgrounds;
* Pager like capability: move tasks between workspaces (virtual desktops), switch between workspaces;
* Multi-monitor capability: create one panel per monitor, showing only the tasks from the current monitor;
* Customizable mouse events.
# Goals
* Be unintrusive and light (in terms of memory, CPU and aesthetic);
* Follow the freedesktop.org specifications;
* Make certain workflows, such as multi-desktop and multi-monitor, easy to use.
# I want it!
* [Install tint2](https://gitlab.com/o9000/tint2/wikis/Install)
# How do I ...
* [Install](https://gitlab.com/o9000/tint2/wikis/Install)
* [Configure](https://gitlab.com/o9000/tint2/blob/master/doc/tint2.md)
* [Add applet not supported by tint2](https://gitlab.com/o9000/tint2/wikis/ThirdPartyApplets)
* [Other frequently asked questions](https://gitlab.com/o9000/tint2/wikis/FAQ)
* [Obtain a stack trace when tint2 crashes](https://gitlab.com/o9000/tint2/wikis/Debug)
# Known issues
* Graphic glitches on Intel graphics cards can be avoided by changing the acceleration method to UXA ([issue 595](https://gitlab.com/o9000/tint2/issues/595))
* Window managers that do not follow exactly the EWMH specification might not interact well with tint2 (known issues for [awesome](https://gitlab.com/o9000/tint2/issues/385), [bspwm](https://gitlab.com/o9000/tint2/issues/524). [openbox-multihead](https://gitlab.com/o9000/tint2/issues/456))
* Full transparency requires a compositor such as Compton (if not provided already by the window manager, as in Compiz/Unity, KDE or XFCE)
# How can I help out?
* Report bugs and ask questions on the [issue tracker](https://gitlab.com/o9000/tint2/issues);
* Contribute to the development by helping us fix bugs and suggesting new features. Please read the contribution guide: [CONTRIBUTING.md](CONTRIBUTING.md)
# Links
* Home page: https://gitlab.com/o9000/tint2
* Git repository: https://gitlab.com/o9000/tint2.git
* Documentation: https://gitlab.com/o9000/tint2/wikis/home
* Downloads: https://gitlab.com/o9000/tint2-archive/tree/master or https://code.google.com/p/tint2/downloads/list
* Old project location (inactive): https://code.google.com/p/tint2
# Screenshots
## Default config:
![Screenshot_2016-01-23_14-42-57](https://gitlab.com/o9000/tint2/uploads/948fa74eca60864352a033580350b4c3/Screenshot_2016-01-23_14-42-57.png)
## Various configs:
* [Screenshots](https://gitlab.com/o9000/tint2/wikis/screenshots)
## Demos
* [Compact panel, separator, color gradients](https://gitlab.com/o9000/tint2/wikis/whats-new-0.13.0.gif)
* [Executor](https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.4.gif)
* [Mouse over effects](https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.3.gif)
* [Distribute size between taskbars, freespace](https://gitlab.com/o9000/tint2/wikis/whats-new-0.12.gif)
## More
* [Tint2 wiki](https://gitlab.com/o9000/tint2/wikis/Home)
Home)