From 4ddbe07a30010d13a60b83195bf3a32c6779106e Mon Sep 17 00:00:00 2001 From: DarthMooMancer <107283522+DarthMooMancer@users.noreply.github.com> Date: Mon, 12 May 2025 02:19:54 -0400 Subject: [PATCH] docs: update to fix .polydev mentions and improper presets --- .gitignore | 2 +- README.md | 4 ++-- bash_scripts/walkup.sh | 1 + docs/installation.md | 4 +++- docs/languages/c.md | 3 +-- docs/languages/cpp.md | 3 +-- docs/languages/lua.md | 2 -- docs/setup.md | 11 ++--------- test.lua | 9 --------- 9 files changed, 11 insertions(+), 28 deletions(-) delete mode 100644 test.lua diff --git a/.gitignore b/.gitignore index ccf637e..5a489dd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ -*.polydev LICENSE Lua_Annotation_CheatSheet/ +venv/ diff --git a/README.md b/README.md index 50e1111..2a61dbf 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ And more on the way! Stay tuned for future updates. ## ๐Ÿ”ฎ **Planned Features** -We're always working to make Polydev better. Hereโ€™s a sneak peek at some exciting plans: +I am always working to make Polydev better. Hereโ€™s a sneak peek at some exciting plans: -- ๐Ÿš€ **Rust Integration**: Leverage Rust to speed up certain aspects of the plugin for faster performance and better scalability. +- Nothing. Just refactoring rn --- diff --git a/bash_scripts/walkup.sh b/bash_scripts/walkup.sh index 7195540..95d7449 100755 --- a/bash_scripts/walkup.sh +++ b/bash_scripts/walkup.sh @@ -5,6 +5,7 @@ DIR="$(pwd)" # Walk up until we find a marker or reach root while [[ ! -f "$DIR/CMakeLists.txt" && \ ! -f "$DIR/package.json" && \ + ! -f "$DIR/venv" && \ ! -d "$DIR/.git" && \ "$DIR" != "/" ]]; do DIR="$(dirname "$DIR")" diff --git a/docs/installation.md b/docs/installation.md index ca5ccfa..f70908b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,7 +4,9 @@ Polydev can be installed using any plugin manager of your choice โ€” or even man > โš ๏ธ **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. -> **Note: Requires Neovim 0.10+** +> **Note: Requires Neovim v0.10 or higher** + +> **Recommended: Neovim v0.11 or higher for proper support --- diff --git a/docs/languages/c.md b/docs/languages/c.md index ae11096..67810c8 100644 --- a/docs/languages/c.md +++ b/docs/languages/c.md @@ -14,7 +14,6 @@ This is the recommended file structure for your C projects using Polydev: | `main.c` | Main C file for the project | | `*.c` | Additional C source files | | `build/` | Folder where the build artifacts will be generated | -| `.polydev` | Polydev metadata file (generated during build) | | `include/` | Folder for header files | | `*.h` | C header files | @@ -29,7 +28,7 @@ Projects/ โ”‚ โ”œโ”€โ”€ main.c โ”‚ โ””โ”€โ”€ *.c โ”œโ”€โ”€ build/ - โ”‚ โ””โ”€โ”€ .polydev + โ”‚ โ””โ”€โ”€ โ””โ”€โ”€ include/ โ””โ”€โ”€ *.h ``` diff --git a/docs/languages/cpp.md b/docs/languages/cpp.md index 22b2442..7eab12f 100644 --- a/docs/languages/cpp.md +++ b/docs/languages/cpp.md @@ -15,7 +15,6 @@ This is the recommended file structure for your C projects using Polydev: | `main.cpp` | Main Cpp file for the project | | `*.cpp` | Additional Cpp source files | | `build/` | Folder where the build artifacts will be generated | -| `.polydev` | Polydev metadata file (generated during build) | | `include/` | Folder for header files | | `*.hpp` | Cpp header files | @@ -30,7 +29,7 @@ Projects/ โ”‚ โ”œโ”€โ”€ main.cpp โ”‚ โ””โ”€โ”€ *.cpp โ”œโ”€โ”€ build/ - โ”‚ โ””โ”€โ”€ .polydev + โ”‚ โ””โ”€โ”€ โ””โ”€โ”€ include/ โ””โ”€โ”€ *.hpp ``` diff --git a/docs/languages/lua.md b/docs/languages/lua.md index 19220af..f76d6a3 100644 --- a/docs/languages/lua.md +++ b/docs/languages/lua.md @@ -14,7 +14,6 @@ Hereโ€™s the suggested directory structure for your Lua projects with Polydev: | Directory/File Path | Description | |----------------------------|-----------------------------------------------------| -| `.polydev` | Project metadata file that Polydev uses for configuration | | `lua/` | Directory containing the main Lua project files | | `lua//init.lua` | The main entry point for your Lua project | @@ -24,7 +23,6 @@ Hereโ€™s the suggested directory structure for your Lua projects with Polydev: Projects/ โ””โ”€โ”€ Lua/ โ””โ”€โ”€ Project_Name/ - โ”œโ”€โ”€ .polydev -- Polydev configuration file โ””โ”€โ”€ lua/ โ””โ”€โ”€ Project_name/ โ””โ”€โ”€ init.lua -- Main Lua file diff --git a/docs/setup.md b/docs/setup.md index 03120d9..4616f5e 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,9 +1,3 @@ -# **Setup** - -> ๐Ÿ’ก **Heads up!** Many language presets in Polydev require a file named `.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 - ## **Project Manager** > Note: The project manager closely follows the netrw keybinds and allows for project management all in one spot @@ -14,6 +8,7 @@ | **/** | `Filter (fuzzy search)` | | **a** | `Create new folder` | | **%** | `Create new file` | +| **x** | `Create new auxilary file (ex. headers)` | | **d** | `Create new project` | | **R** | `Rename file/folder` | | **D** | `Delete file/folder` | @@ -82,13 +77,11 @@ keybinds = { -- c -- keybinds = { ["pr"] = "CRun", - ["pb"] = "NewCHeaderFile", } -- cpp -- keybinds = { ["pr"] = "CppRun", - ["pb"] = "NewCppHeaderFile", } ``` @@ -96,7 +89,7 @@ keybinds = { ## **Terminal Configuration** ```lua terminal = { - preset = "centered", -- "centered", "center_panel", "right_panel", "cornered" + preset = "max", -- "max", "center", "right", "corner" border = true, number = true, relativenumber = true -- requires number to be true diff --git a/test.lua b/test.lua deleted file mode 100644 index a8a0e5c..0000000 --- a/test.lua +++ /dev/null @@ -1,9 +0,0 @@ --- Get absolute path to this Lua file (or any file in your plugin) -local plugin_path = debug.getinfo(1, "S").source:sub(2) -local plugin_dir = vim.fn.fnamemodify(plugin_path, ":h") - --- Build the full path to your script -local script_path = plugin_dir .. "/bash_scripts/walkup.sh" - --- Run the script and get output -local dir = vim.fn.system(script_path):gsub("%s+$", "")