From 4d34b5d1bea7d2e9633cae17d6e568efb35bf017 Mon Sep 17 00:00:00 2001
From: DarthMooMancer <Haynes.a763@outlook.com>
Date: Wed, 14 May 2025 13:26:04 -0400
Subject: [PATCH] docs: update to setup and installation

Removing redudancy in installation at the top. Changed setup to use
names for each setting for clarity for people who don't know what is
going on
---
 docs/installation.md |  4 +-
 docs/setup.md        | 89 ++++++++++++++++++++++++++++----------------
 2 files changed, 58 insertions(+), 35 deletions(-)

diff --git a/docs/installation.md b/docs/installation.md
index d0bcb89..13d6e55 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -2,9 +2,7 @@
 
 Polydev can be installed using any plugin manager of your choice — or even manually. Below are some examples for popular managers to get you started.
 
-> ⚠️ **Disclaimer**: The `opts` and configuration values shown below are simply examples. You can customize them based on your preferences or even omit them entirely if not needed.
-
-> **Requires: Requires Neovim v0.10 or higher**
+> **Requirement**: Neovim v0.10+
 
 ---
 
diff --git a/docs/setup.md b/docs/setup.md
index 7f8d310..c22acd1 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -19,84 +19,109 @@
 ## **Project Root**
 ```lua
 -- Automatically creates a project root if not already made.
--- Stores all projects in this root, not src files and such.
--- For now, the top project root is assumed at ~/Projects until I refactor my code.
+-- Stores all projects in this root
+
+-- Global --
+globals = {
+    project_root = "~/Projects"
+}
 
 -- Lua --
-project_root = "~/Projects/Lua"
+lua = {
+    project_root = "~/{global_root}/Lua"
+}
 
 -- Html --
-project_root = "~/Projects/Html"
+html = {
+    project_root = "~/{global_root}/Html"
+}
 
 -- Rust --
-project_root = "~/Projects/Rust"
+rust = {
+    project_root = "~/{global_root}/Rust"
+}
 
 -- Java --
-project_root = "~/Projects/Java"
+java = {
+    project_root = "~/{global_root}/Java"
+}
 
 -- Python --
-project_root = "~/Projects/Python"
+python = {
+    project_root = "~/{global_root}/Python"
+}
 
 -- C --
-project_root = "~/Projects/C"
+c = {
+    project_root = "~/{global_root}/C"
+}
 
 -- C++ --
-project_root = "~/Projects/CPP"
+cpp = {
+    project_root = "~/{global_root}/CPP"
+}
 ```
 
 ## **Keybinds**
 
 ```lua
 -- globals --
-keybinds = {
-    -- Opens the Project Manager UI
-    ["<leader>po"] = "PolydevManager",
+globals = {
+    keybinds = {
+        ["<leader>po"] = "PolydevManager",
+    }
 }
 
 -- rust --
-keybinds = {
-    ["<leader>pr"] = "RustRun",
+rust = {
+    keybinds = {
+        ["<leader>pr"] = "RustRun",
+    }
 }
 
 -- java --
-keybinds = {
-    ["<leader>pr"] = "JavaRun",
+java = {
+    keybinds = {
+        ["<leader>pr"] = "JavaRun",
+    }
 }
 
 -- python --
-keybinds = {
-    ["<leader>pr"] = "PythonRun",
-    ["<leader>pb"] = "PythonPip",
+python = {
+    keybinds = {
+        ["<leader>pr"] = "PythonRun",
+        ["<leader>pb"] = "PythonPip",
+    }
 }
 
 -- lua --
-keybinds = {
-    ["<leader>pr"] = "LuaRun",
+lua = {
+    keybinds = {
+        ["<leader>pr"] = "LuaRun",
+    }
 }
 
 -- c --
-keybinds = {
-    ["<leader>pr"] = "CRun",
+c = {
+    keybinds = {
+        ["<leader>pr"] = "CRun",
+    }
 }
 
 -- cpp --
-keybinds = {
-    ["<leader>pr"] = "CppRun",
+cpp = {
+    keybinds = {
+        ["<leader>pr"] = "CppRun",
+    }
 }
 
 ```
 
 ## **Terminal Configuration**
 ```lua
+-- In Neovim 0.11+, numbers don't work so they will be reimplemented later
 terminal = {
     preset = "max", -- "max", "center", "right", "corner"
     border = true,
-    number = true,
-    relativenumber = true -- requires number to be true
 }
 ```
-
-## 🚀 Final Thoughts and Customizations
-This guide provided you with the basic configuration steps for setting up Polydev with your preferred package manager and customizing key aspects like project names, keybinds, and terminal settings.
-
-You can further explore other Polydev features and modify the configuration to suit your development workflow with language specific configs.