DarthMooMancer/vern-nvim
1
1
Fork 0
Code Issues 3 Pull Requests Activity

Updated language docs

Browse Source
This commit is contained in:
DarthMooMancer
2025-04-16 03:38:34 -04:00
parent 068a650e85
commit 29643fe1d5
5 changed files with 238 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/languages/c.md
+41 -9
View File
@@ -1,19 +1,49 @@
## Key Notes
* Currently with the way I have it work, the first time you build a project, it will error out no matter what. Just rerun the build and then if there are errors it is most likely a you issue more than a me issue.
### C Setup for Polydev 🛠️
#### Key Notes ⚠️
> **Important**: The first time you build a project, it might throw an error. This is expected behavior. Simply rerun the build, and if errors persist, it may be an issue with your project setup rather than the plugin.
---
#### Keybinds 🎮
You can customize keybinds for your C projects with Polydev.
| Keybind | Action |
|---------------------|--------------------------------------------------|
| `<leader>pb` | Build all C files in the `src` directory |
| `<leader>pr` | Run `<Project_name>` in your build directory |
| `<leader>nh` | Create a new header file in the current project’s `src` folder |
#### Configuration Example:
## Keybinds
```lua
require("Polydev").c.setup({
keybinds = {
["<Esc>"] = "CloseTerminal" -- Closes terminal, esc by default.
["<leader>pb"] = "CBuild", -- Building all C Files in src directory in.
["<leader>pr"] = "CRun", -- Runs <Project_name> in your build directory
["<leader>nf"] = "NewCFile", -- Creates a new c file in the current project src folder
["<leader>nh"] = "NewCHeaderFile", -- Creates a new header file in the current project src folder
["<leader>pb"] = "CBuild", -- Build all C files in the src directory
["<leader>pr"] = "CRun", -- Run <Project_name> in your build directory
["<leader>nh"] = "NewCHeaderFile" -- Create a new header file in the current project’s src folder
}
})
```
## File Structure
---
#### File Structure 📂
This is the recommended file structure for your C projects using Polydev:
| Directory/File Path | Description |
|----------------------------|------------------------------------------------------|
| `CMakeLists.txt` | Configuration file for your project build |
| `src/` | Folder containing source files for the project |
| `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 |
#### Example Structure:
```md
Projects/
└── C/
@@ -27,3 +57,5 @@ Projects/
└── include/
└── *.h
```
---