Skip to content

Commit 3a3212e

Browse files
authored
Merge pull request #35 from godalming123/main
Improve readme
2 parents 279c94b + 836d394 commit 3a3212e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<img src=logo.svg align=right>
22

3-
# worm
3+
# Worm
44

55
Worm is a tiny, dynamic, tag-based window manager written in the Nim language.
66
It supports both a floating mode and master-stack tiling with gaps and struts.
7-
Check out the screenshots on the wiki for some examples of how it looks.
7+
Check out the [screenshots on the wiki](https://github.com/codic12/worm/wiki/Screenshots) for some examples of how it looks.
88

9-
## build / install
9+
## Build / install
1010

1111
Install Nim >= 1.4.0, for example through Choosenim. Clone this repo and run
1212

@@ -21,9 +21,9 @@ Alternatively, for users using Arch, you can use the AUR package worm-git.
2121
$ yay -Sy worm-git
2222
```
2323

24-
## configuration
24+
## Configuration
2525

26-
### autostart
26+
### Autostart
2727

2828
Worm will try to execute the file `~/.config/worm/rc` on startup.
2929
Simply create it as a shell-script to execute your favorite applications with
@@ -32,20 +32,20 @@ worm.
3232

3333
An example can be found [here](/examples/rc).
3434

35-
### keybindings
35+
### Keybindings
3636

3737
Worm does not have a built-in keyboard mapper, so you should use something like
3838
[sxhkd](https://github.com/baskerville/sxhkd).
39-
Please read [the doc](docs/wormc.md) to understand how wormc works before
39+
Please read [the docs](docs/wormc.md) to understand how wormc works before
4040
writing your own sxhkdrc.
4141

4242
An example sxhkdrc can be found [here](/examples/sxhkdrc).
4343

44-
## license
44+
## License
4545

4646
Licensed under the MIT license. See the LICENSE file for more info.
4747

48-
## credits
48+
## Credits
4949

5050
Thanks to [phisch](https://github.com/phisch) for making the logo!
5151

0 commit comments

Comments
 (0)