docs: update to fix .polydev mentions and improper presets
This commit is contained in:
@@ -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
|
||||
|
||||
---
|
||||
|
||||
|
||||
+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 |
|
||||
| `*.c` | Additional C source files |
|
||||
| `build/` | Folder where the build artifacts will be generated |
|
||||
| `<project_name>.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/
|
||||
│ └── <project_name>.polydev
|
||||
│ └── <main-executable>
|
||||
└── include/
|
||||
└── *.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 |
|
||||
| `*.cpp` | Additional Cpp source files |
|
||||
| `build/` | Folder where the build artifacts will be generated |
|
||||
| `<project_name>.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/
|
||||
│ └── <project_name>.polydev
|
||||
│ └── <main-executable>
|
||||
└── include/
|
||||
└── *.hpp
|
||||
```
|
||||
|
||||
@@ -14,7 +14,6 @@ Here’s the suggested directory structure for your Lua projects with Polydev:
|
||||
|
||||
| Directory/File Path | Description |
|
||||
|----------------------------|-----------------------------------------------------|
|
||||
| `<Project_name>.polydev` | Project metadata file that Polydev uses for configuration |
|
||||
| `lua/` | Directory containing the main Lua project files |
|
||||
| `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/
|
||||
└── Lua/
|
||||
└── Project_Name/
|
||||
├── <Project_name>.polydev -- Polydev configuration file
|
||||
└── lua/
|
||||
└── Project_name/
|
||||
└── 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**
|
||||
> 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 = {
|
||||
["<leader>pr"] = "CRun",
|
||||
["<leader>pb"] = "NewCHeaderFile",
|
||||
}
|
||||
|
||||
-- cpp --
|
||||
keybinds = {
|
||||
["<leader>pr"] = "CppRun",
|
||||
["<leader>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
|
||||
|
||||
Reference in New Issue
Block a user