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
This commit is contained in:
DarthMooMancer
2025-05-14 13:26:04 -04:00
parent fa7851a787
commit 4d34b5d1be
2 changed files with 58 additions and 35 deletions
+1 -3
View File
@@ -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. 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. > **Requirement**: Neovim v0.10+
> **Requires: Requires Neovim v0.10 or higher**
--- ---
+49 -24
View File
@@ -19,84 +19,109 @@
## **Project Root** ## **Project Root**
```lua ```lua
-- Automatically creates a project root if not already made. -- Automatically creates a project root if not already made.
-- Stores all projects in this root, not src files and such. -- Stores all projects in this root
-- For now, the top project root is assumed at ~/Projects until I refactor my code.
-- Global --
globals = {
project_root = "~/Projects"
}
-- Lua -- -- Lua --
project_root = "~/Projects/Lua" lua = {
project_root = "~/{global_root}/Lua"
}
-- Html -- -- Html --
project_root = "~/Projects/Html" html = {
project_root = "~/{global_root}/Html"
}
-- Rust -- -- Rust --
project_root = "~/Projects/Rust" rust = {
project_root = "~/{global_root}/Rust"
}
-- Java -- -- Java --
project_root = "~/Projects/Java" java = {
project_root = "~/{global_root}/Java"
}
-- Python -- -- Python --
project_root = "~/Projects/Python" python = {
project_root = "~/{global_root}/Python"
}
-- C -- -- C --
project_root = "~/Projects/C" c = {
project_root = "~/{global_root}/C"
}
-- C++ -- -- C++ --
project_root = "~/Projects/CPP" cpp = {
project_root = "~/{global_root}/CPP"
}
``` ```
## **Keybinds** ## **Keybinds**
```lua ```lua
-- globals -- -- globals --
keybinds = { globals = {
-- Opens the Project Manager UI keybinds = {
["<leader>po"] = "PolydevManager", ["<leader>po"] = "PolydevManager",
}
} }
-- rust -- -- rust --
keybinds = { rust = {
keybinds = {
["<leader>pr"] = "RustRun", ["<leader>pr"] = "RustRun",
}
} }
-- java -- -- java --
keybinds = { java = {
keybinds = {
["<leader>pr"] = "JavaRun", ["<leader>pr"] = "JavaRun",
}
} }
-- python -- -- python --
keybinds = { python = {
keybinds = {
["<leader>pr"] = "PythonRun", ["<leader>pr"] = "PythonRun",
["<leader>pb"] = "PythonPip", ["<leader>pb"] = "PythonPip",
}
} }
-- lua -- -- lua --
keybinds = { lua = {
keybinds = {
["<leader>pr"] = "LuaRun", ["<leader>pr"] = "LuaRun",
}
} }
-- c -- -- c --
keybinds = { c = {
keybinds = {
["<leader>pr"] = "CRun", ["<leader>pr"] = "CRun",
}
} }
-- cpp -- -- cpp --
keybinds = { cpp = {
keybinds = {
["<leader>pr"] = "CppRun", ["<leader>pr"] = "CppRun",
}
} }
``` ```
## **Terminal Configuration** ## **Terminal Configuration**
```lua ```lua
-- In Neovim 0.11+, numbers don't work so they will be reimplemented later
terminal = { terminal = {
preset = "max", -- "max", "center", "right", "corner" preset = "max", -- "max", "center", "right", "corner"
border = true, 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.