From 29bbbf96d0b187f7eebb385ef96aeb4f6b401567 Mon Sep 17 00:00:00 2001 From: DarthMooMancer <107283522+DarthMooMancer@users.noreply.github.com> Date: Fri, 11 Apr 2025 17:19:26 -0400 Subject: [PATCH] Update setup.md to use proper lazy config and update proper configs --- docs/setup.md | 83 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 65 insertions(+), 18 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 61a6939..411fbd4 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,15 +1,10 @@ # Setup and Customizing ## Project Name +* You can change the default directory for the project. The project can be made from anywhere you want. +* It will automatically make the new Root Directory, so you don't have to worry about making it. -### Without Lazy -```lua -require("Polydev").language.setup({ - project_root = "~/Home/..." -- Default: ~/Projects/Language -}) -``` - -### With Lazy +### Lazy ```lua return { ... @@ -21,27 +16,55 @@ return { } ... } - ``` -* You can change the default directory for the project. The project can be made from anywhere you want. -* It will automatically make the new Root Directory, so you don't have to worry about making it. + +### Others +```lua +require("Polydev").language.setup({ + project_root = "~/Home/..." -- Default: ~/Projects/Language +}) +``` ## Keybinds -* Every language has the same keybinds so it is easy to remember keybinds and not have to remember thousands of keybinds. -* The only keybind that doesnt change no matter what happens is creating a new project. Enter the language you want, then enter the project name and boom! new project. +* Every language has the almost same keybinds so it is easy to remember keybinds and not have to remember thousands of keybinds. +* Some languages have separate functions (python has a pip keybind for example) adding more keybinds + +Key/ +├── *Universal, cannot be changed through specific language settings +└── *Per-language, can be changed separately by language if wanted + +### Lazy +```lua +return { + ... + opts = { + = { + [""] = "CloseTerminal", -- Planned to be *Universal -- However can be changed per language for now + ["pb"] = "languageBuild", -- *Per-language + ["pr"] = "languageRun", -- *Per-language + ["nf"] = "NewLanguageFile", --*Universal -- such as .c files + ["nh"] = "NewLanguageSecondaryFile", --*Universal -- such as .h files + } + } + ... +} +``` + +### Others ```lua require("Polydev"}.language.setup({ keybinds = [ - [""] = "CloseTerminal", - ["pb"] = "languageBuild", - ["pr"] = "languageRun", - ["nf"] = "NewlanguageFile", -- such as .c files - ["nh"] = "Newlanguage_secondaryFile", -- such as .h files + [""] = "CloseTerminal", -- Planned to be *Universal -- However can be changed per language for now + ["pb"] = "languageBuild", -- *Per-language + ["pr"] = "languageRun", -- *Per-language + ["nf"] = "NewLanguageFile", --*Universal -- such as .c files + ["nh"] = "NewLanguageSecondaryFile", --*Universal -- such as .h files } }) ``` ## Terminal +!!! I plan on making the terminal settings a global setting instead of language specific, just need to figure out how * The terminal has a couple of options that can be customized and with more to come - Each is set to 0 by default * **_right_padding:_** Padding for the right width of the terminal @@ -54,6 +77,30 @@ require("Polydev"}.language.setup({ * **_relativenumber:_** Relative numbers indicate distances from the cursor, only works if number is enabled * **_scroll:_** Allows scrolling in terminal +### Lazy +```lua +return { + ... + opts = { + = { + terminal = { + right_padding = 0, + bottom_padding = 0, + left_padding = 0, + top_padding = 0, + border = true, + number = true, + relativenumber = true, + scroll = true, + } + } + } + ... +} +``` + +### Others + ```lua -- These are just defaults, so no need to copy them require("Polydev").language.setup({