Mirrors/SketchyBar
2
0
Fork 0
mirror of https://github.com/FelixKratz/SketchyBar synced 2024-11-10 13:54:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

added getting started section and cleaned up readme

Browse source
This commit is contained in:
Felix Kratz 2022-05-14 20:39:24 +02:00
parent 2a99ed5e92
commit b62f811a35
1 changed files with 14 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -30,9 +30,7 @@ shell scripts.
</p>
## Features
* Performance friendly
* No accessibility permissions needed
* Fully scriptable
* Fully configurable
* Supports drawing native macOS menu bar applications
@ -42,59 +40,28 @@ shell scripts.
* Support for graphs
* Per display and per space individualization
## Installation
### Brew Install
```bash
brew tap FelixKratz/formulae
brew install sketchybar
```
Do not forget to copy the example configuration files to your home directory
(the brew installation specific commands are listed in the caveats section after the brew install is finished).
The default configuration is intentionally sparse, so if you are looking for something more sophisticated as a starting point, you might want to look at
[this discussion](https://github.com/FelixKratz/SketchyBar/discussions/47) or my personal [dotfiles](https://github.com/FelixKratz/dotfiles).
## 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* 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) and start customizing 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.
Run the bar automatically at startup:
```bash
brew services start sketchybar
```
or in the command line with verbose output:
```bash
sketchybar
```
## 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).
### Fonts
The default sketchybar font is the Hack Nerd Font:
```bash
brew tap homebrew/cask-fonts
brew install --cask font-hack-nerd-font
```
if you experience missing icons you might need to install it. Any font
of your liking can be used in sketchybar.
### Plugins
When you use/create additional plugins, make sure that they are made executable via
```bash
chmod +x name/of/plugin.sh
```
If you run sketchybar from the command line directly with the command `sketchybar` you will see
all outputs and error messages from your scripts.
The default plugin folder is located in `~/.config/sketchybar/plugins`.
Plugins need to be referenced with absolute paths because relative paths will not be resolved correctly.
Have a look at the [discussion](https://github.com/FelixKratz/SketchyBar/discussions/12) for plugins and share your own if you want to.
You should of course vet the code from all plugins before executing them to make sure they are not harming your computer.
## Supporting this project
## 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
## 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 [docs](https://github.com/FelixKratz/SketchyBar/blob/master/DOCS.md).
## 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.