feat: credits and licenses

diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt
new file mode 100644 (file)
index 0000000..2bb775e
--- /dev/null
+++ b/LICENSES/CC-BY-SA-4.0.txt
@@ -0,0 +1 @@
+dabruin.kak logo © 2023 by Thomas Teixeira is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/

diff --git a/LICENSES/ISC.txt b/LICENSES/ISC.txt
deleted file mode 100644 (file)
index 4921131..0000000
--- a/LICENSES/ISC.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-Copyright (c) 2015-2020, Ivan Tham <pickfire@riseup.net>
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

diff --git a/README.md b/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..8988e999c6b76bed771a26bfc53e1aed18dbe173 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,60 @@
+## dabruin.kak  
+One color, multiple attributes.  
+**D**im, **A**ccent, **B**old, **R**everse, **U**nderline, **I**talic, **N**othing.  
+  
+![common dab stylized](https://pic.t0.vc/YFCU)  
+  
+### installation  
+Install as any other plugin. More information [here](https://github.com/mawww/kakoune/wiki/Installing-Plugins)  
+  
+### palette  
+Here is *dabruin*'s default palette.  
+I did not use the terminal palette to avoid non-optimal contrasts and keep sane defaults.  
+  
+![default dabruin palette](https://pic.t0.vc/WMNK)  
+  
+### customization  
+If the `dabruin_accent` option exists, **before** calling the colorscheme command,  
+its value will be used as `dabruin_accent` color.  
+The following code snippet will load *dabruin* with a bright red as its accent color.  
+```kak  
+declare-option str dabruin_accent 'rgb:ff0000'  
+colorscheme dabruin  
+```  
+Each time you (re-)load *dabruin* theme the `dabruin_accent` option will be read and used.  
+For example, the following snippet changes the accent to a random value at startup, and  
+when you run the `dabruin-random-accent` command.  
+```kak  
+declare-option str dabruin_accent  
+define-command -params 0 dabruin-random-accent %{  
+    set-option global dabruin_accent %sh{  
+       printf 'rgb:%s' "$(tr -dc 'a-fA-F0-9' </dev/urandom | head -c 6)"  
+    }  
+    colorscheme dabruin  
+}  
+dabruin-random-accent  
+```  
+  
+### specifics about dim  
+The dim terminal attribute was not cooperating with the bold and reverse attributes  
+on certain terminal implementation, see [this discussion](https://discuss.kakoune.com/t/question-about-dim-and-bold-attribute-in-faces/2332) for more information.  
+So, I wrote a simple shell function to mimic its effect, and remove the need of two options (`dabruin_accent{,_dim}`).  
+```sh  
+calculate_dim() {  
+       printf "$1" | cut -d: -f2 | fold -b2 |  
+       while read -r hex; do  
+                       base10="$(printf '%d' "0x${hex}")"  
+                       printf '%02x' "$((base10 * 5 / 9))"  
+       done | xargs printf 'rgb:%s'  
+}  
+```  
+  
+### credits  
+None of the credit sources support or endorse this project, as far as I know.  
+  
+#### theme  
+This theme is **heavily inspired** by [Romain Lafourcade's vim-bruin project](https://git.sr.ht/~romainl/vim-bruin).  
+  
+#### logo  
+dabruin.kak's logo is a transformation of [Hans Hillewaert picture](https://en.wikipedia.org/wiki/Common_dab#/media/File:Limanda_limanda.jpg), which is licensed under CC BY-SA 4.0.  
+To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/