chore: organized and optimized startup

docs: updated documentation to be simpler and up to date
2025-05-08 00:35:37 -04:00
parent 15913c75b7
commit 368a5d98f8
8 changed files with 734 additions and 267 deletions
@@ -1,18 +1,14 @@
-# 📦 Installation
+# **Installation**

-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.

-> 💡 **Heads up!** Many language presets in Polydev require a file named `<project_name>.polydev` in your project root. If it's missing, Polydev will let you know (loudly 😅).
-
-> **Note**: Languages that require to build just need to be run, building is builtin to the run command
+> **Note: Requires Neovim 0.10+**

 ---

-## 🛌 Lazy.nvim
-
-> This is the **recommended** way if you're using [Lazy.nvim](https://github.com/folke/lazy.nvim):
+## **Lazy.nvim**

 ```lua
 return {
@@ -21,26 +17,13 @@ return {
        "MunifTanjim/nui.nvim",
        "nvim-lua/plenary.nvim"
    },
-    opts = { -- Below are just example values
-        lua = {
-            project_root = "~/Projects/Lua",
-            keybinds = {
-                ["<leader>pr"] = "LuaRun",
-            },
-        },
-        terminal = {
-            border = true,
-            number = true,
-        },
-    },
+    opts = {}, -- Setup is later on for configs
 }
 ```

 ---

-## 🧸 Mini.deps
-
-For users of [mini.nvim](https://github.com/echasnovski/mini.nvim)'s dependency manager:
+## **Mini.deps**

 ```lua
 MiniDeps.add({
@@ -51,25 +34,12 @@ MiniDeps.add({
    }
 })

-require("Polydev").setup({
-    rust = {
-        project_root = "~/Projects/Rust",
-        keybinds = {
-            ["<leader>pr"] = "RustRun",
-        },
-    },
-    terminal = {
-        border = true,
-        number = true,
-    },
-})
+require("Polydev").setup({})
 ```

 ---

-## 📁 Packer.nvim
-
-For fans of [Packer.nvim](https://github.com/wbthomason/packer.nvim):
+## **Packer.nvim**

 ```lua
 use({
@@ -78,65 +48,9 @@ use({
        "MunifTanjim/nui.nvim",
        "nvim-lua/plenary.nvim"
    },
-    config = function()
-        require("Polydev").setup({
-            python = {
-                project_root = "~/Projects/Python",
-                keybinds = {
-                    ["<leader>pb"] = "PythonPip",
-                    ["<leader>pr"] = "PythonRun",
-                },
-            },
-            terminal = {
-                relativenumber = true,
-            },
-        })
-    end,
 })
+
+require("Polydev").setup({})
 ```

 ---
-
-## 🔐 Vim-Plug (Classic)
-
-Even if you're still using [vim-plug](https://github.com/junegunn/vim-plug), you’re covered:
-
-```vim
-Plug 'DarthMooMancer/Polydev'
-Plug 'MunifTanjim/nui.nvim'
-Plug 'nvim-lua/plenary.nvim'
-
-lua << EOF
-require("Polydev").setup({
-    c = {
-        project_root = "~/Projects/C",
-        keybinds = {
-            ["<leader>pr"] = "CRun",
-        },
-    },
-    terminal = {
-        number = true,
-    },
-})
-EOF
-```
-
---
-
-## 🛠 Manual Install
-
-Clone the repo into your `~/.config/nvim/lua` or any runtime path:
-
-```bash
-git clone https://github.com/DarthMooMancer/Polydev ~/.config/nvim/lua/Polydev
-```
-
-Then in your config:
-
-```lua
-require("Polydev").setup({
-    terminal = {
-        border = true,
-    },
-})
-```