mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-04-19 19:34:24 +02:00
docs(compiling): add info about build deps
This commit is contained in:
parent
d84139a914
commit
83a49165c4
3 changed files with 39 additions and 3 deletions
17
README.md
17
README.md
|
@ -6,12 +6,23 @@ It uses GTK3 and gtk-layer-shell.
|
|||
The bar can be styled to your liking using CSS and hot-loads style changes.
|
||||
For information and examples on styling please see the [wiki](https://github.com/JakeStanger/ironbar/wiki).
|
||||
|
||||

|
||||

|
||||
|
||||
## Features
|
||||
|
||||
- First-class support for Sway and Hyprland, but should (mostly) work on any wlroots compositor.
|
||||
- Fully themeable with CSS and hot-loaded styles.
|
||||
- Support for multiple configuration languages.
|
||||
- Popups used by widgets to show rich content and controls on click.
|
||||
- Out of the box widgets which can be used to create anything from a lightweight to a more traditional desktop experience.
|
||||
- Ability to create custom widgets (including popups), run scripts and inject dynamic content.
|
||||
|
||||
## Installation
|
||||
|
||||
### Cargo
|
||||
|
||||
Ensure you have the [build dependencies](https://github.com/JakeStanger/ironbar/wiki/compiling#Build-requirements) installed.
|
||||
|
||||
```sh
|
||||
cargo install ironbar
|
||||
```
|
||||
|
@ -74,6 +85,8 @@ in case you don't want to compile Ironbar.
|
|||
|
||||
### Source
|
||||
|
||||
Ensure you have the [build dependencies](https://github.com/JakeStanger/ironbar/wiki/compiling#Build-requirements) installed.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/jakestanger/ironbar.git
|
||||
cd ironbar
|
||||
|
@ -83,7 +96,7 @@ install target/release/ironbar ~/.local/bin/ironbar
|
|||
```
|
||||
|
||||
By default, all features are enabled.
|
||||
See [here](https://github.com/JakeStanger/ironbar/wiki/compiling) for controlling which features are included.
|
||||
See [here](https://github.com/JakeStanger/ironbar/wiki/compiling#features) for controlling which features are included.
|
||||
|
||||
[repo](https://github.com/jakestanger/ironbar)
|
||||
|
||||
|
|
|
@ -9,6 +9,28 @@ cargo build --release
|
|||
install target/release/ironbar ~/.local/bin/ironbar
|
||||
```
|
||||
|
||||
## Build requirements
|
||||
|
||||
To build from source, you must have GTK (>= 3.22) and GTK Layer Shell installed.
|
||||
|
||||
### Arch
|
||||
|
||||
```shell
|
||||
pacman -S gtk3 gtk-layer-shell
|
||||
```
|
||||
|
||||
### Ubuntu/Debian
|
||||
|
||||
```shell
|
||||
apt install libgtk-3-dev libgtk-layer-shell-dev
|
||||
```
|
||||
|
||||
### Fedora
|
||||
|
||||
```shell
|
||||
dnf install gtk3 gtk-layer-shell
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
By default, all features are enabled for convenience. This can result in a significant compile time.
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
# Guides
|
||||
|
||||
- [Compiling from source](compiling)
|
||||
- [Configuration guide](configuration-guide)
|
||||
- [Scripts](scripts)
|
||||
- [Images](images)
|
||||
- [Styling guide](styling-guide)
|
||||
- [Examples](https://github.com/JakeStanger/ironbar/tree/master/examples)
|
||||
|
||||
# Examples
|
||||
|
||||
|
@ -17,6 +17,7 @@
|
|||
|
||||
# Modules
|
||||
|
||||
- [Clipboard](clipboard)
|
||||
- [Clock](clock)
|
||||
- [Custom](custom)
|
||||
- [Focused](focused)
|
||||
|
|
Loading…
Add table
Reference in a new issue