From b402b22a759248aaa0f1cfce38c9cdd87962cbf7 Mon Sep 17 00:00:00 2001
From: Lavender <endie.lavender@protonmail.com>
Date: Wed, 28 Apr 2021 20:09:02 -0700
Subject: [PATCH] Improvements

---
 .config/nvim/lua/plugins.lua               | 26 ++++++++--------
 .local/share/applications/goneovim.desktop | 13 ++++++++
 .zshrc                                     |  2 +-
 readme.md                                  | 36 +++++++++++++++++++---
 4 files changed, 58 insertions(+), 19 deletions(-)
 create mode 100755 .local/share/applications/goneovim.desktop

diff --git a/.config/nvim/lua/plugins.lua b/.config/nvim/lua/plugins.lua
index 539b82fb..32cfd290 100644
--- a/.config/nvim/lua/plugins.lua
+++ b/.config/nvim/lua/plugins.lua
@@ -1,16 +1,14 @@
 require("packer").startup({{
+    -- plugin manager
     "wbthomason/packer.nvim",
 
-    -- {
-    --     "lukas-reineke/indent-blankline.nvim",
-    --     branch = "lua", 
-    -- },
-
+    -- colors
     {
         "olimorris/onedark.nvim", 
         requires = "rktjmp/lush.nvim",
     },
 
+    -- syntax parsing
     {
         "nvim-treesitter/nvim-treesitter",
         run = ":TSUpdate",
@@ -39,8 +37,10 @@ require("packer").startup({{
         end,
     },
 
+    -- underlines all words that match the word under the cursor
     "yamatsum/nvim-cursorline",
 
+    -- helps to find cursor when it jumps a far distance
     {
         "edluffy/specs.nvim",
         config = function()
@@ -64,13 +64,15 @@ require("packer").startup({{
         end,
     },
 
-    { 
+    -- highlights color codes with their color
+    {
         "norcalli/nvim-colorizer.lua", 
         config = function() 
             require("colorizer").setup() 
         end,
     },
 
+    -- automatically adds matching brackets, quotation marks, etc
     {
         "windwp/nvim-autopairs",
         config = function()
@@ -80,20 +82,19 @@ require("packer").startup({{
         end,
     },
 
+    -- finds errors & warnings in code
     "vim-syntastic/syntastic",
 
+    -- tools for rust programming
     "rust-lang/rust.vim",
 
+    -- python formatter
     {
         "psf/black",
         run = ":BlackUpgrade",
     },
 
-    {
-        "Vimjas/vim-python-pep8-indent",
-        ft = "python",
-    },
-
+    -- discord rich presence
     "andweeb/presence.nvim",
 }})
 
@@ -129,6 +130,3 @@ vim.g.syntastic_check_on_wq = 1
 
 -- rust.vim
 vim.g.rustfmt_autosave = 1
-
--- vim-python-pep8-indent
-vim.g.python_pep8_indent_multiline_string = -2
diff --git a/.local/share/applications/goneovim.desktop b/.local/share/applications/goneovim.desktop
new file mode 100755
index 00000000..79c37d75
--- /dev/null
+++ b/.local/share/applications/goneovim.desktop
@@ -0,0 +1,13 @@
+#!/usr/bin/env xdg-open
+# Desktop entry modified by Endie
+# Original by Goneovim AUR package maintainers
+[Desktop Entry]
+Version=1.0
+Type=Application
+Name=Goneovim
+Comment=Neovim GUI written in Golang, using a Golang qt backend
+Exec=/usr/bin/goneovim --nvim=/usr/bin/nvim %F
+Icon=vim
+Terminal=false
+StartupNotify=false
+Categories=Application;
diff --git a/.zshrc b/.zshrc
index 7ae833e5..2702a3d1 100644
--- a/.zshrc
+++ b/.zshrc
@@ -45,7 +45,7 @@ PROMPT="%F{5}%d%f%F{3}  %f "
 RPROMPT="%F{2}(%f%F{1}%?%f%F{2})"
 
 alias back="cd \$OLDPWD"
-alias dots="git --git-dir=$HOME/Dotfiles --work-tree=$HOME"
+alias dots="git --git-dir=$HOME/dotfiles --work-tree=$HOME"
 alias update="yay -Syu && nvim -c PackerUpdate"
 
 sys
diff --git a/readme.md b/readme.md
index 6242fd4f..171a4777 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,34 @@
 # Dotfiles
-You can clone directly into your home directory to use these.\
-I use the method described here https://www.anand-iyer.com/blog/2018/a-simpler-way-to-manage-your-dotfiles.html.
+My configurations for programs.
 
-The Neovim dots (.config/nvim) require Neovim 0.5.0 or greater.\
-The system info script & .zshrc requires a nerd font (https://www.nerdfonts.com/).
\ No newline at end of file
+## Requirements
+The Neovim dots (.config/nvim) require Neovim 0.5.0 or greater, with packer installed.\
+The system info script & .zshrc requires a nerd font (https://www.nerdfonts.com/).
+
+## Installation
+`git clone https://gitdab.com/endie/dotfiles.git`, then move/symlink the files you want to the 
+correct places relative to your home directory\
+Alternatively, you can clone these directly into your home directory with 
+`git clone --separate-git-dir=$HOME/dotfiles https://gitdab.com/endie/dotfiles.git ~`,
+but that will not work if the files are already in your home directory
+
+## Help
+### None of the Neovim configuration is working / errors when starting Neovim
+* Make sure your Neovim meets the requirements
+> * Currently 0.5.0 is not released yet, so you will have to use a prerelease build
+> * Install packer by running 
+`git clone https://github.com/wbthomason/packer.nvim
+~/.local/share/nvim/site/pack/packer/start/packer.nvim`
+* If your Neovim meets the requirements, try running `:PackerSync` in Neovim
+
+### The presence.nvim Neovim plugin is not working
+* You might have to add Neovim as a game in your Discord client (settings > game activity)
+
+### The Materia GTK theme looks wrong when generated with the oomox colors
+* Run `find /path/to/generated_theme -name "*.css" -print | xargs sed -i "s/230000/242424/g"`,
+replacing `/path/to/generated_theme` with the location of the theme you generated 
+(by default ~/.themes/oomox-Pastls).
+
+## Credits
+Method for storing dotfiles:
+https://www.anand-iyer.com/blog/2018/a-simpler-way-to-manage-your-dotfiles.html