Updated language docs

2025-04-16 03:38:34 -04:00
parent 068a650e85
commit 29643fe1d5
5 changed files with 238 additions and 33 deletions
@@ -0,0 +1,61 @@
+### 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:
+
+```lua
+require("Polydev").c.setup({
+  keybinds = {
+    ["<leader>pb"] = "CppBuild",    -- Build all C files in the src directory
+    ["<leader>pr"] = "CppRun",      -- Run <Project_name> in your build directory
+    ["<leader>nh"] = "NewCppHeaderFile"  -- Create a new header file in the current project’s src folder
+  }
+})
+```
+
+---
+
+#### 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.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                                       |
+
+#### Example Structure:
+
+```md
+Projects/
+└── Cpp/
+    └── Project_Name/
+        ├── CMakeLists.txt
+        ├── src/
+        │   ├── main.cpp
+        │   └── *.cpp
+        ├── build/
+        │   └── <project_name>.polydev
+        └── include/
+            └── *.hpp
+```
+
+---