Skip to content

Commit c506ea1

Browse files
committed
docs: move simple-bar docs into its own README
1 parent 1a667c9 commit c506ea1

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,12 @@ This project contains examples of [Quickshell](https://quickshell.outfoxxed.me/)
99

1010
2. [Install the QML plugin for niri.](https://github.com/imiric/qml-niri#installation)
1111

12-
3. For specific widgets:
13-
- Battery: [UPower](https://upower.freedesktop.org/)
14-
15-
4. Fonts/icons: [Barlow](https://tribby.com/fonts/barlow/)
12+
3. See the `README` within each example directory for additional instructions and dependencies.
1613

1714

1815
### Usage
1916

20-
Clone this repository, and copy or symlink any of the examples into `~/.config/quickshell/`. E.g.:
17+
Clone this repository, and copy or symlink any of the example directories into `~/.config/quickshell/`. E.g.:
2118
```shell
2219
git clone https://github.com/imiric/quickshell-niri.git
2320
ln -s "$PWD/quickshell-niri/simple-bar" ~/.config/quickshell/niri-simple-bar
@@ -36,13 +33,9 @@ spawn-at-startup "quickshell" "--config" "niri-simple-bar"
3633

3734
### Examples
3835

39-
#### [Simple bar](/simple-bar)
36+
- [Simple bar](/simple-bar)
4037

41-
![Simple bar](/assets/simple-bar.png)
42-
43-
A plain bar with a workspace indicator and switcher, centered title of the currently focused window, and text battery and date/time widgets.
44-
45-
This is a slightly modified version of [SimpleQuickshellBar](https://github.com/the-ink-serpent/SimpleQuickshellBar), but for niri instead of Hyprland.
38+
![Simple bar](/simple-bar/screenshot.png)
4639

4740

4841
## License

simple-bar/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Simple bar
2+
3+
![Simple bar](./screenshot.png)
4+
5+
A plain bar with a workspace indicator and switcher, centered title of the currently focused window, and text battery and date/time widgets.
6+
7+
This is a slightly modified version of [SimpleQuickshellBar](https://github.com/the-ink-serpent/SimpleQuickshellBar), but for niri instead of Hyprland.
8+
9+
10+
### Dependencies
11+
12+
- Battery widget: [UPower](https://upower.freedesktop.org/)
13+
14+
- Font: [Barlow](https://tribby.com/fonts/barlow/)
File renamed without changes.

0 commit comments

Comments
 (0)