chore: readme update (#35)

senelway · Jul 30, 2023 · c4048ea · c4048ea
1 parent 5a54014
commit c4048ea
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 2,454 deletions.
diff --git a/kitty/README.md b/kitty/README.md
diff --git a/kitty/kitty.conf b/kitty/kitty.conf
diff --git a/kitty/theme.conf b/kitty/theme.conf
diff --git a/nvim/README.md b/nvim/README.md
@@ -3,6 +3,10 @@
 ```sh
 brew install neovim
 brew install ripgrep # is required for grep searching with Telescope (OPTIONAL).
+
+git clone [email protected]:senelway/dotfiles.git ~/.config/_tmp
+cd ~/.config/_tmp
+mv nvim ../nvim
 ```
 
 ## Uninstall
@@ -21,7 +25,7 @@ cd ~/.config/nvim/lua/custom/
 # mappings.lua there is a custom hotkeys
 ```
 
-## Hotkeys
+## All Hotkeys
 
 ```sh
 ## <leader>ch
@@ -41,25 +45,8 @@ sudo nvim
 
 ## Plugins list
 
-- [Chat gpt](https://github.com/jackMort/ChatGPT.nvim)
-- [Symbols in right tree](https://github.com/simrat39/symbols-outline.nvim)
-- [Todos and etc](https://github.com/folke/todo-comments.nvim)
-- [Troubles](https://github.com/folke/trouble.nvim)
-- [Copilot](https://github.com/zbirenbaum/copilot.lua)
-
-## ChatGPT settings
-
-```sh
-# generate a token https://platform.openai.com/account/api-keys
-
-export OPENAI_API_KEY=""
-
-# ~/.zshrc
-# export OPENAI_API_KEY=""
-
-# hotkey is `<leader>gg`
-# ./lua/custom/mappings.lua
-```
+- [Custom](https://github.com/senelway/dotfiles/blob/main/nvim/lua/custom/plugins.lua)
+- [Base](https://github.com/senelway/dotfiles/blob/main/nvim/lua/plugins/init.lua)
 
 ## Spellcheck
 

diff --git a/nvim/lazy-lock.json b/nvim/lazy-lock.json
@@ -28,6 +28,7 @@
   "nvim-web-devicons": { "branch": "master", "commit": "efbfed0567ef4bfac3ce630524a0f6c8451c5534" },
   "nvterm": { "branch": "main", "commit": "5ae78fb332e92447121d2af58a6313189a7799fb" },
   "plenary.nvim": { "branch": "master", "commit": "267282a9ce242bbb0c5dc31445b6d353bed978bb" },
+  "project.nvim": { "branch": "main", "commit": "8c6bad7d22eef1b71144b401c9f74ed01526a4fb" },
   "rest.nvim": { "branch": "main", "commit": "22673c848768ff25517154a5aebfebc0c77d0b4f" },
   "telescope.nvim": { "branch": "master", "commit": "22735947d84d78f29436c203f0a4b8dc15dda204" },
   "trouble.nvim": { "branch": "main", "commit": "40aad004f53ae1d1ba91bcc5c29d59f07c5f01d3" },

diff --git a/nvim/lua/custom/configs/overrides.lua b/nvim/lua/custom/configs/overrides.lua
@@ -31,7 +31,7 @@ M.treesitter = {
 }
 
 M.telescope = {
-  extensions_list = { "harpoon", "themes", "terms" },
+  extensions_list = { "harpoon", "themes", "terms", "projects" },
 }
 
 M.mason = {

diff --git a/nvim/lua/custom/mappings.lua b/nvim/lua/custom/mappings.lua
@@ -86,6 +86,7 @@ M.telescope = {
     ["<leader>gbb"] = { "<cmd> Telescope git_branches <CR>", "git branches" },
     ["<leader>fs"] = { "<cmd> Telescope grep_string <CR>", "grep with word under cursor" },
     ["<leader>fc"] = { "<cmd> Telescope current_buffer_fuzzy_find <CR>", "Find in current buffer" },
+    ["<leader>fp"] = { "<cmd> Telescope projects <CR>", "Open projects list" },
   },
 }
 

diff --git a/nvim/lua/custom/plugins.lua b/nvim/lua/custom/plugins.lua
@@ -4,7 +4,64 @@ local overrides = require "custom.configs.overrides"
 local plugins = {
   -- Override plugin definition options
   --
+  {
+    "neovim/nvim-lspconfig",
+    dependencies = {
+      -- format & linting
+      {
+        "jose-elias-alvarez/null-ls.nvim",
+        config = function()
+          require "custom.configs.null-ls"
+        end,
+      },
+    },
+    config = function()
+      require "plugins.configs.lspconfig"
+      require "custom.configs.lspconfig"
+    end, -- Override to setup mason-lspconfig
+  },
+
+  -- override plugin configs
+  {
+    "williamboman/mason.nvim",
+    opts = overrides.mason,
+  },
 
+  {
+    "nvim-treesitter/nvim-treesitter",
+    opts = overrides.treesitter,
+  },
+  {
+    "nvim-tree/nvim-tree.lua",
+    opts = overrides.nvimtree,
+  },
+
+  -- Install a plugin
+  {
+    "max397574/better-escape.nvim",
+    event = "InsertEnter",
+    config = function()
+      require("better_escape").setup()
+    end,
+  },
+
+  -------------------------------
+  -------------------------------
+  -------------------------------
+  -------------------------------
+  -------------------------------
+  -------------------------------
+
+  {
+    "ahmedkhalf/project.nvim",
+    dependencies = "nvim-telescope/telescope.nvim",
+    cmd = { "ProjectRoot" },
+    config = function()
+      require("project_nvim").setup {
+        manual_mode = true,
+      }
+    end,
+  },
   {
     "kdheepak/lazygit.nvim",
     dependencies = "nvim-lua/plenary.nvim",
@@ -80,52 +137,6 @@ local plugins = {
       }
     end,
   },
-  -------------------------------
-  -------------------------------
-  -------------------------------
-  -------------------------------
-  -------------------------------
-  -------------------------------
-  {
-    "neovim/nvim-lspconfig",
-    dependencies = {
-      -- format & linting
-      {
-        "jose-elias-alvarez/null-ls.nvim",
-        config = function()
-          require "custom.configs.null-ls"
-        end,
-      },
-    },
-    config = function()
-      require "plugins.configs.lspconfig"
-      require "custom.configs.lspconfig"
-    end, -- Override to setup mason-lspconfig
-  },
-
-  -- override plugin configs
-  {
-    "williamboman/mason.nvim",
-    opts = overrides.mason,
-  },
-
-  {
-    "nvim-treesitter/nvim-treesitter",
-    opts = overrides.treesitter,
-  },
-  {
-    "nvim-tree/nvim-tree.lua",
-    opts = overrides.nvimtree,
-  },
-
-  -- Install a plugin
-  {
-    "max397574/better-escape.nvim",
-    event = "InsertEnter",
-    config = function()
-      require("better_escape").setup()
-    end,
-  },
 }
 
 return plugins