add license and readme

2 files changed, 74 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ce41f08
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2021 la-ninpre
+
+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
new file mode 100644
index 0000000..7056435
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# la-ninpre's dotfiles
+
+i use gnu stow to deploy my dotfiles. installation is very straightforward:
+
+``` shell
+$ git clone https://git.aaoth.xyz/dotfiles.git
+$ cd dotfiles
+$ ./install
+```
+
+note that you will need to specify `--recurse-submodules` option if you also
+want to have my xmonad config. for xmonad-specific installation instructions
+refer to [it's repo][0].
+
+## programs
+
+a list of programs that i have configurations for.
+
+* bash
+
+* neovim
+
+* doom-emacs
+
+* mpd
+
+* moc
+
+* alacritty
+
+* starship prompt
+
+## scripts
+
+a list of useful (for me) shell scripts also provided in current repo.
+* clean_local_ssh -- purges localhost entries from `.ssh/known_hosts`.
+  (yes it's very silly, but i need it because i ssh to my vms and ssh is
+  always complaining about wrong host keys)
+
+* fossil-update -- updates fossil to latest version
+
+* keylookup -- receives a public key from keyserver (because gpg is not
+  always able to do so for some reason)
+  
+* nimi_sewi -- a wrapper for [nimi sewi][1] that copies it's output to
+  clipboard and gives a notification
+  
+* paperbackup -- makes a printable qr-code backup for gpg secret key
+
+* print_codes -- makes a printable qr-code backup for otp recovery codes
+
+* rand -- outputs random string
+
+## license
+
+all code in this repo is licensed under an isc license.
+
+[0]:https://git.aaoth.xyz/xmonad-config.git
+[1]:https://fsl.aaoth.xyz/nimisewi