mirror of
https://github.com/FelixKratz/SketchyBar
synced 2025-02-17 04:58:28 +00:00
74 lines
3.9 KiB
Markdown
74 lines
3.9 KiB
Markdown
<p align="center">
|
|
<img src="images/Sbar.svg" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://felixkratz.github.io/SketchyBar/setup">Install</a>
|
|
<span> • </span>
|
|
<a href="https://felixkratz.github.io/SketchyBar/config/bar">Documentation</a>
|
|
<span> • </span>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/discussions/47">Setups</a>
|
|
<span> • </span>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/discussions/12">Plugins</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://opensource.org/licenses/"><img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg"></a>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/releases"><img src="https://img.shields.io/github/v/release/FelixKratz/SketchyBar.svg?style=flat&color=orange" /></a>
|
|
<a href="https://github.com/FelixKratz/SketchyBar/releases"><img src="https://img.shields.io/github/commits-since/FelixKratz/SketchyBar/latest.svg?color=orange"></a>
|
|
<a href="https://en.wikipedia.org/wiki/Free_and_open-source_software"><img src="https://img.shields.io/badge/FOSS-100%25-green.svg?style=flat"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for users that like playing around with
|
|
shell scripts.
|
|
</p>
|
|
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/FelixKratz/SketchyBar/discussions/47">More Setups</a>
|
|
</p>
|
|
|
|
## Features
|
|
* Performance friendly
|
|
* Fully scriptable
|
|
* Fully configurable
|
|
* Supports drawing native macOS menu bar applications (Aliases)
|
|
* Powerful event and scripting system
|
|
* Animation System
|
|
* Popup Menus
|
|
* Mouse Support
|
|
* Support for graphs
|
|
* Per display and per space individualization
|
|
|
|
## Getting Started
|
|
Refer to the installation guide in the [documentation](https://felixkratz.github.io/SketchyBar/setup) to get the program set up.
|
|
Once this is sorted you can start to become familiar with the syntax of sketchybar by going through the default [*sketchybarrc*](https://github.com/FelixKratz/SketchyBar/blob/master/sketchybarrc) file,
|
|
which is located in `~/.config/sketchybar/sketchybarrc`.
|
|
|
|
All commands and options are explained in detail in the relevant sections
|
|
of the configuration [documentation](https://felixkratz.github.io/SketchyBar/config/bar). You can try the commands directly from
|
|
the commandline to see which affect they have and how they alter the bar. Once you have become familiar with the syntax you can
|
|
look for a config to start from [here](https://github.com/FelixKratz/SketchyBar/discussions/47) or start from scratch and customize
|
|
everything to your liking.
|
|
|
|
You might also enjoy looking at the [Tips & Tricks](https://felixkratz.github.io/SketchyBar/config/tricks) section
|
|
for some further tips on your journey. If you are searching for functional items you might want to check the
|
|
[plugins](https://github.com/FelixKratz/SketchyBar/discussions/12) section if someone has already created what you are looking for.
|
|
|
|
## Documentation
|
|
For the full documentation of all commands and properties please refer to the [website](https://felixkratz.github.io/SketchyBar/config/bar)
|
|
or if you prefer a single document, see the [markdown version of the docs](https://github.com/FelixKratz/SketchyBar/blob/master/DOCS.md).
|
|
|
|
If questions remain, feel free to consult the [Q&A](https://github.com/FelixKratz/SketchyBar/discussions/categories/q-a) section.
|
|
|
|
## Supporting
|
|
*You* can support this project is many ways:
|
|
- By creating issues and pull-requests if you encounter problems
|
|
- By sharing your [plugins](https://github.com/FelixKratz/SketchyBar/discussions/12) and [setups](https://github.com/FelixKratz/SketchyBar/discussions/47)
|
|
- By starring the project on GitHub
|
|
- By donating to a charity of your choice
|
|
|
|
## Credits
|
|
This project was forked from *[spacebar](https://github.com/cmacrae/spacebar)* and completely reimagined and rewritten. <br>
|
|
The original idea is based on the status bar that was included in *[yabai](https://github.com/koekeishiya/yabai)* before getting removed.
|