docs: update to fix .polydev mentions and improper presets
This commit is contained in:
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
*.polydev
|
|
||||||
LICENSE
|
LICENSE
|
||||||
Lua_Annotation_CheatSheet/
|
Lua_Annotation_CheatSheet/
|
||||||
|
venv/
|
||||||
|
|||||||
@@ -39,9 +39,9 @@ And more on the way! Stay tuned for future updates.
|
|||||||
|
|
||||||
## 🔮 **Planned Features**
|
## 🔮 **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
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ DIR="$(pwd)"
|
|||||||
# Walk up until we find a marker or reach root
|
# Walk up until we find a marker or reach root
|
||||||
while [[ ! -f "$DIR/CMakeLists.txt" && \
|
while [[ ! -f "$DIR/CMakeLists.txt" && \
|
||||||
! -f "$DIR/package.json" && \
|
! -f "$DIR/package.json" && \
|
||||||
|
! -f "$DIR/venv" && \
|
||||||
! -d "$DIR/.git" && \
|
! -d "$DIR/.git" && \
|
||||||
"$DIR" != "/" ]]; do
|
"$DIR" != "/" ]]; do
|
||||||
DIR="$(dirname "$DIR")"
|
DIR="$(dirname "$DIR")"
|
||||||
|
|||||||
@@ -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.
|
> ⚠️ **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
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+1
-2
@@ -14,7 +14,6 @@ This is the recommended file structure for your C projects using Polydev:
|
|||||||
| `main.c` | Main C file for the project |
|
| `main.c` | Main C file for the project |
|
||||||
| `*.c` | Additional C source files |
|
| `*.c` | Additional C source files |
|
||||||
| `build/` | Folder where the build artifacts will be generated |
|
| `build/` | Folder where the build artifacts will be generated |
|
||||||
| `<project_name>.polydev` | Polydev metadata file (generated during build) |
|
|
||||||
| `include/` | Folder for header files |
|
| `include/` | Folder for header files |
|
||||||
| `*.h` | C header files |
|
| `*.h` | C header files |
|
||||||
|
|
||||||
@@ -29,7 +28,7 @@ Projects/
|
|||||||
│ ├── main.c
|
│ ├── main.c
|
||||||
│ └── *.c
|
│ └── *.c
|
||||||
├── build/
|
├── build/
|
||||||
│ └── <project_name>.polydev
|
│ └── <main-executable>
|
||||||
└── include/
|
└── include/
|
||||||
└── *.h
|
└── *.h
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ This is the recommended file structure for your C projects using Polydev:
|
|||||||
| `main.cpp` | Main Cpp file for the project |
|
| `main.cpp` | Main Cpp file for the project |
|
||||||
| `*.cpp` | Additional Cpp source files |
|
| `*.cpp` | Additional Cpp source files |
|
||||||
| `build/` | Folder where the build artifacts will be generated |
|
| `build/` | Folder where the build artifacts will be generated |
|
||||||
| `<project_name>.polydev` | Polydev metadata file (generated during build) |
|
|
||||||
| `include/` | Folder for header files |
|
| `include/` | Folder for header files |
|
||||||
| `*.hpp` | Cpp header files |
|
| `*.hpp` | Cpp header files |
|
||||||
|
|
||||||
@@ -30,7 +29,7 @@ Projects/
|
|||||||
│ ├── main.cpp
|
│ ├── main.cpp
|
||||||
│ └── *.cpp
|
│ └── *.cpp
|
||||||
├── build/
|
├── build/
|
||||||
│ └── <project_name>.polydev
|
│ └── <main-executable>
|
||||||
└── include/
|
└── include/
|
||||||
└── *.hpp
|
└── *.hpp
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ Here’s the suggested directory structure for your Lua projects with Polydev:
|
|||||||
|
|
||||||
| Directory/File Path | Description |
|
| Directory/File Path | Description |
|
||||||
|----------------------------|-----------------------------------------------------|
|
|----------------------------|-----------------------------------------------------|
|
||||||
| `<Project_name>.polydev` | Project metadata file that Polydev uses for configuration |
|
|
||||||
| `lua/` | Directory containing the main Lua project files |
|
| `lua/` | Directory containing the main Lua project files |
|
||||||
| `lua/<Project_name>/init.lua` | The main entry point for your Lua project |
|
| `lua/<Project_name>/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/
|
Projects/
|
||||||
└── Lua/
|
└── Lua/
|
||||||
└── Project_Name/
|
└── Project_Name/
|
||||||
├── <Project_name>.polydev -- Polydev configuration file
|
|
||||||
└── lua/
|
└── lua/
|
||||||
└── Project_name/
|
└── Project_name/
|
||||||
└── init.lua -- Main Lua file
|
└── init.lua -- Main Lua file
|
||||||
|
|||||||
+2
-9
@@ -1,9 +1,3 @@
|
|||||||
# **Setup**
|
|
||||||
|
|
||||||
> 💡 **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
|
|
||||||
|
|
||||||
## **Project Manager**
|
## **Project Manager**
|
||||||
> Note: The project manager closely follows the netrw keybinds and allows for project management all in one spot
|
> 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)` |
|
| **/** | `Filter (fuzzy search)` |
|
||||||
| **a** | `Create new folder` |
|
| **a** | `Create new folder` |
|
||||||
| **%** | `Create new file` |
|
| **%** | `Create new file` |
|
||||||
|
| **x** | `Create new auxilary file (ex. headers)` |
|
||||||
| **d** | `Create new project` |
|
| **d** | `Create new project` |
|
||||||
| **R** | `Rename file/folder` |
|
| **R** | `Rename file/folder` |
|
||||||
| **D** | `Delete file/folder` |
|
| **D** | `Delete file/folder` |
|
||||||
@@ -82,13 +77,11 @@ keybinds = {
|
|||||||
-- c --
|
-- c --
|
||||||
keybinds = {
|
keybinds = {
|
||||||
["<leader>pr"] = "CRun",
|
["<leader>pr"] = "CRun",
|
||||||
["<leader>pb"] = "NewCHeaderFile",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
-- cpp --
|
-- cpp --
|
||||||
keybinds = {
|
keybinds = {
|
||||||
["<leader>pr"] = "CppRun",
|
["<leader>pr"] = "CppRun",
|
||||||
["<leader>pb"] = "NewCppHeaderFile",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -96,7 +89,7 @@ keybinds = {
|
|||||||
## **Terminal Configuration**
|
## **Terminal Configuration**
|
||||||
```lua
|
```lua
|
||||||
terminal = {
|
terminal = {
|
||||||
preset = "centered", -- "centered", "center_panel", "right_panel", "cornered"
|
preset = "max", -- "max", "center", "right", "corner"
|
||||||
border = true,
|
border = true,
|
||||||
number = true,
|
number = true,
|
||||||
relativenumber = true -- requires number to be true
|
relativenumber = true -- requires number to be true
|
||||||
|
|||||||
@@ -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+$", "")
|
|
||||||
Reference in New Issue
Block a user