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 - ["po"] = "PolydevManager", +globals = { + keybinds = { + ["po"] = "PolydevManager", + } } -- rust -- -keybinds = { - ["pr"] = "RustRun", +rust = { + keybinds = { + ["pr"] = "RustRun", + } } -- java -- -keybinds = { - ["pr"] = "JavaRun", +java = { + keybinds = { + ["pr"] = "JavaRun", + } } -- python -- -keybinds = { - ["pr"] = "PythonRun", - ["pb"] = "PythonPip", +python = { + keybinds = { + ["pr"] = "PythonRun", + ["pb"] = "PythonPip", + } } -- lua -- -keybinds = { - ["pr"] = "LuaRun", +lua = { + keybinds = { + ["pr"] = "LuaRun", + } } -- c -- -keybinds = { - ["pr"] = "CRun", +c = { + keybinds = { + ["pr"] = "CRun", + } } -- cpp -- -keybinds = { - ["pr"] = "CppRun", +cpp = { + keybinds = { + ["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.