From 276671e2d5fc00ff61c82701cbb2d8fbff7ae2f1 Mon Sep 17 00:00:00 2001 From: kitty piapiac Date: Sat, 8 Aug 2020 17:11:11 -0700 Subject: =?UTF-8?q?(.=E3=81=A5=E2=97=A1=EF=B9=8F=E2=97=A1)=E3=81=A5=20repl?= =?UTF-8?q?ace=20README.md=20with=20README.adoc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit testing asciidoc instead of markdown --- README.adoc | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.adoc (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..f5f7067 --- /dev/null +++ b/README.adoc @@ -0,0 +1,55 @@ += (/・・)ノ kauw window manager +fox-cat + +:hardbreaks: +:1: https://nim-lang.org +:2: link:src/config.def.nim +:3: https://wiki.archlinux.org/index.php/Xephyr +:4: link:TODO + +kauw is an expiremental tiling window manager built for x11 using nim +currently it is very minimal, but more features are planned/ hoped for + +.goals (・・；) +**** +i have a few goals in mind while working on this project +* be written and configured entirely in {1}[nim] +* be easily configurable +* be easily hackable +* be fairly small and minimalist +* help myself learn and get around x11 +**** + +.(。ヘ°) configuration +**** +the default configuration file is {2}[`config.def.nim`] +duplicate it and rename it to `config.nim`, and you can configure it from there +**** + +.development ⊂(・ヮ・⊂) +**** +clone using +[source, bash] +---- +$ git clone https://github.com/fox-cat/kauw +$ cd kauw +---- +you can build using +[source, bash] +---- +$ nimble build +---- +and you can test using {3}[Xephyr] +[source, bash] +---- +$ Xephyr -ac -screen 1980x1080 -br -reset -terminate 2> /dev/null :2 & +$ DISPLAY=:1 ./kauw +---- +**** + +.(.づ◡﹏◡)づ. todo +**** +see {4}[TODO] +**** + +image::img/kauw.png[kauw] \ No newline at end of file -- cgit v1.2.3