From 02a3634ca950c29c1fa9f30de76875991c61180e Mon Sep 17 00:00:00 2001 From: godalming123 Date: Tue, 28 Dec 2021 13:55:11 +0000 Subject: [PATCH 1/3] improve readme improve readme with capital letters and links to the docs and screenshots on wiki --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bf3af45..3207ab6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -# worm +# Worm -Worm is a tiny, dynamic, tag-based window manager written in the Nim language. +Worm is a tiny, suckless, dynamic, tag-based window manager written in the Nim language. It supports both a floating mode and master-stack tiling with gaps and struts. -Check out the screenshots on the wiki for some examples of how it looks. +Check out the [screenshots on the wiki](https://github.com/codic12/worm/wiki/Screenshots) for some examples of how it looks. -## build / install +## Docs + +The worm docs are located at [here](https://github.com/codic12/worm/tree/main/docs) + +## Build / install Install Nim >= 1.4.0, for example through Choosenim. Clone this repo and run @@ -21,9 +25,9 @@ Alternatively, for users using Arch, you can use the AUR package worm-git. $ yay -Sy worm-git ``` -## configuration +## Configuration -### autostart +### Autostart Worm will try to execute the file `~/.config/worm/rc` on startup. Simply create it as a shell-script to execute your favorite applications with @@ -32,7 +36,7 @@ worm. An example can be found [here](/examples/rc). -### keybindings +### Keybindings Worm does not have a built-in keyboard mapper, so you should use something like [sxhkd](https://github.com/baskerville/sxhkd). @@ -41,11 +45,11 @@ writing your own sxhkdrc. An example sxhkdrc can be found [here](/examples/sxhkdrc). -## license +## License Licensed under the MIT license. See the LICENSE file for more info. -## credits +## Credits Thanks to [phisch](https://github.com/phisch) for making the logo! From cfcfc96341d3cc649435d934af1a0fd95ab924b1 Mon Sep 17 00:00:00 2001 From: godalming123 Date: Tue, 28 Dec 2021 13:57:50 +0000 Subject: [PATCH 2/3] remove unecersarry docs subheading when there is alredy a link to the docs and example configs page --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 3207ab6..e2fd9d4 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,6 @@ Worm is a tiny, suckless, dynamic, tag-based window manager written in the Nim l It supports both a floating mode and master-stack tiling with gaps and struts. Check out the [screenshots on the wiki](https://github.com/codic12/worm/wiki/Screenshots) for some examples of how it looks. -## Docs - -The worm docs are located at [here](https://github.com/codic12/worm/tree/main/docs) - ## Build / install Install Nim >= 1.4.0, for example through Choosenim. Clone this repo and run @@ -40,7 +36,7 @@ An example can be found [here](/examples/rc). Worm does not have a built-in keyboard mapper, so you should use something like [sxhkd](https://github.com/baskerville/sxhkd). -Please read [the doc](docs/wormc.md) to understand how wormc works before +Please read [the docs](docs/wormc.md) to understand how wormc works before writing your own sxhkdrc. An example sxhkdrc can be found [here](/examples/sxhkdrc). From 836d394eb0e7700626fa819dc3b8ee7636bed94b Mon Sep 17 00:00:00 2001 From: godalming123 Date: Fri, 31 Dec 2021 18:21:04 +0000 Subject: [PATCH 3/3] remove suckless from readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2fd9d4..74c0cb0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Worm -Worm is a tiny, suckless, dynamic, tag-based window manager written in the Nim language. +Worm is a tiny, dynamic, tag-based window manager written in the Nim language. It supports both a floating mode and master-stack tiling with gaps and struts. Check out the [screenshots on the wiki](https://github.com/codic12/worm/wiki/Screenshots) for some examples of how it looks.