Initial commit

1 files changed, 65 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7293d68
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Various dotfiles for my [OpenBSD](https://openbsd.org/) - [HerbstluftWM](https://github.com/herbstluftwm/herbstluftwm) setup.
+HerbstluftWM is a manual tiling window manager for X.
+
+![ScreenShot](screenshot.jpg)
+
+## Details
+
+Below is a list of some of the packages that I use for my current setup.<br />
+The wallpaper featured in the screenshots can be found here: https://cdna.artstation.com/p/assets/images/images/015/554/914/large/artur-sadlos-to-sh300-ooh-as-05i.jpg
+
+  
+- **Operating System** --- [OpenBSD](https://openbsd.org/)
+- **Resource Monitor** --- [Btop](https://github.com/aristocratos/btop)
+- **Window Manager** --- [HerbstluftWM](https://github.com/herbstluftwm/herbstluftwm)
+- **Status Bar** --- [Polybar](https://github.com/polybar/polybar)
+- **Screen Locker** --- [Swaylock](https://github.com/mortie/swaylock-effects)
+- **Screenshots** --- [Maim](https://github.com/naelstrof/maim)
+- **Shell** --- [ksh]() 
+- **Completion** --- [Custom oksh Completion](https://git.smithies.me.uk/openbsd-desktop-dotfiles/tree/.kshrc)
+- **Terminal** --- [Xterm]()
+- **Notification Daemon** --- [Dunst](https://github.com/dunst-project/dunst)
+- **Application Launcher** --- [rofi](https://github.com/davatorium/rofi)
+- **Document Scanner** -- [Xsane](https://gitlab.com/sane-project/frontend/xsane)
+- **Editor** --- [Neovim](https://github.com/neovim/neovim)
+  - **Plugins**
+	  - [Alpha-nvim](https://github.com/goolord/alpha-nvim)
+      - [Nvim-colorizer](https://github.com/norcalli/nvim-colorizer.lua)
+      - [Comment.nvim](https://github.com/numToStr/Comment.nvim)
+      - [Gruvbox.nvim](https://github.com/ellisonleao/gruvbox.nvim)
+      - [Indent-blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
+      - [Lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
+      - [Mason.nvim](https://github.com/williamboman/mason.nvim)
+      - [Mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim)
+      - [Noice](https://github.com/folke/noice.nvim)
+      - [Nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
+      - [Nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
+      - [Nvim-tree](https://github.com/nvim-tree/nvim-tree.lua)
+      - [Nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
+      - [nvim-ts-autotag](https://github.com/windwp/nvim-ts-autotag)
+      - [Nvim-webdev-icons](https://github.com/nvim-tree/nvim-web-devicons)
+      - [Telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
+      - [Vim-illuminate](https://github.com/RRethy/vim-illuminate)
+      - [Which key](https://github.com/folke/which-key.nvim)
+- **Web Browser** --- [Qutebrowser](https://www.qutebrowser.org)
+- **PDF Viewer** --- [Zathura](https://git.pwmt.org/pwmt/zathura)
+- **IRC** --- [Weechat](https://weechat.org/)
+- **RSS Feed Reader** --- [Newsboat](https://newsboat.org/)
+- **Youtube Downloader** --- [Yt-dlp (youtube-dl fork)](https://github.com/yt-dlp/yt-dlp)
+- **Video player** --- [mpv](https://github.com/mpv-player/mpv)
+- **Email Client** 
+    - [aerc](https://git.sr.ht/~rjarry/aerc)
+    - [isync](https://isync.sourceforge.io/)
+    - [msmtp](https://marlam.de/msmtp/)
+    - [dante](https://www.inet.no/dante/)
+    - [w3m](https://w3m.sourceforge.net/)
+    - [msmtpqueue](https://github.com/marlam/msmtp-mirror/tree/master/scripts/msmtpqueue)
+
+## Keybindings
+### Window manager controls
+| Keys                                 | Action                    |
+| ------------------------------------ | ------------------------- |
+| <kbd>MOD+SHIFT + c</kbd>             | Kill window               |
+| <kbd>MOD + ENTER</kbd>               | Spawn terminal            |
+| <kbd>MOD + d</kbd>                   | Rofi menu               |
+| <kbd>SHIFT + MOD + p</kbd>           | Rofi power menu         |