diff --git a/docs/languages/c.md b/docs/languages/c.md index 4b305bd..ae11096 100644 --- a/docs/languages/c.md +++ b/docs/languages/c.md @@ -1,26 +1,9 @@ -### C Setup for Polydev 🛠️ - -#### Keybinds 🎮 -You can customize keybinds for your C projects with Polydev. - -| Keybind | Action | -|---------------------|--------------------------------------------------| -| `pr` | Run `` in your build directory | -| `nh` | Create a new header file in the current project’s `src` folder | - -#### Configuration Example: - +### **Build** ```lua -require("Polydev").c.setup({ - keybinds = { - ["pr"] = "CRun", -- Run in your build directory - ["nh"] = "NewCHeaderFile" -- Create a new header file in the current project’s src folder - } -}) +-- Adds build attributes when compiling if you need extra arguments +build_attributes = "" ``` ---- - #### File Structure 📂 This is the recommended file structure for your C projects using Polydev: @@ -50,5 +33,4 @@ Projects/ └── include/ └── *.h ``` - --- diff --git a/docs/languages/cpp.md b/docs/languages/cpp.md index e427131..22b2442 100644 --- a/docs/languages/cpp.md +++ b/docs/languages/cpp.md @@ -1,24 +1,8 @@ -### C Setup for Polydev 🛠️ - -#### Keybinds 🎮 -You can customize keybinds for your C projects with Polydev. - -| Keybind | Action | -|---------------------|--------------------------------------------------| -| `pr` | Run `` in your build directory | -| `nh` | Create a new header file in the current project’s `src` folder | - -#### Configuration Example: - +### Build ```lua -require("Polydev").c.setup({ - keybinds = { - ["pr"] = "CppRun", -- Run in your build directory - ["nh"] = "NewCppHeaderFile" -- Create a new header file in the current project’s src folder - } -}) +-- Adds build attributes when compiling if you need extra arguments +build_attributes = "" ``` - --- #### File Structure 📂 diff --git a/docs/languages/html.md b/docs/languages/html.md new file mode 100644 index 0000000..1ee18d9 --- /dev/null +++ b/docs/languages/html.md @@ -0,0 +1 @@ +Nothing here yet! Html is supported however! diff --git a/docs/languages/java.md b/docs/languages/java.md index 5f2bd57..7e95a4b 100644 --- a/docs/languages/java.md +++ b/docs/languages/java.md @@ -1,28 +1,4 @@ -### Java Setup for Polydev ☕️ - -#### Keybinds 🎮 -You can customize the keybinds for your Java projects in Polydev. - -| Keybind | Action | -|---------------------|-----------------------------------------------------| -| `pr` | Run `Main.java` from the `out` folder in your project | -| `nf` | Create a new Java file in the `src` folder | - -#### Configuration Example: - -```lua --- These are defaults, so no need to copy them -require("Polydev").java.setup({ - keybinds = { - ["pr"] = "JavaRun", -- Run Main.java in the out folder - ["nf"] = "NewJavaFile" -- Create a new Java file in the src folder - } -}) -``` - ---- - -#### Java Features ✨ +### **Java Features** * **Java Build and Run**: Polydev allows you to build all Java files in the `src` directory with the press of a keybind. Once built, you can run the project from the `out` folder, with the `Main.java` file executed automatically. @@ -32,7 +8,7 @@ require("Polydev").java.setup({ --- -#### File Structure 📂 +#### File Structure Here’s the recommended structure for your Java projects using Polydev: | Directory/File Path | Description | diff --git a/docs/languages/lua.md b/docs/languages/lua.md index b4b2422..19220af 100644 --- a/docs/languages/lua.md +++ b/docs/languages/lua.md @@ -1,35 +1,4 @@ -### Lua Setup for Polydev 🐢 - -#### Key Notes ⚠️ - -* Polydev provides seamless integration with Lua projects, allowing you to easily run and manage Lua code. -* You must include a `.polydev` file in your project root directory for Polydev to recognize the project. Missing this file will lead to errors. -* The file structure should be organized to ensure smooth execution and functionality. - ---- - -#### Keybinds 🎮 - -Below are the default keybinds for Lua projects using Polydev. You can adjust them to suit your personal preferences. - -| Keybind | Action | -|---------------------|-------------------------------------------------| -| `pr` | Run the Lua project | - -##### Configuration Example: - -```lua --- These are the defaults for Lua, adjust as needed -require("Polydev").lua.setup({ - keybinds = { - ["pr"] = "LuaRun", -- Run the Lua project - } -}) -``` - ---- - -#### Lua Features ✨ +### **Lua Features** * **Run Lua Projects**: Easily run your Lua project from within your terminal using the `pr` keybind. This automatically runs your `init.lua` or the entry point of your Lua code. diff --git a/docs/languages/rust.md b/docs/languages/rust.md new file mode 100644 index 0000000..a05c24b --- /dev/null +++ b/docs/languages/rust.md @@ -0,0 +1 @@ +Nothing here yet! Rust is supported however! diff --git a/lua/Polydev/configs.lua b/lua/Polydev/configs.lua index c2641d5..ac58d07 100644 --- a/lua/Polydev/configs.lua +++ b/lua/Polydev/configs.lua @@ -43,7 +43,6 @@ M.defaults = { ["pr"] = "CRun", ["nh"] = "NewCHeaderFile", }, - build_attributes = "" }, cpp = { project_root = "~/Projects/Cpp", diff --git a/mkdocs.yml b/mkdocs.yml index 37f36fa..bafa3d0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,8 @@ nav: - Cpp: languages/cpp.md - Lua: languages/lua.md - Python: languages/python.md + - Rust: languages/rust.md + - Html: languages/html.md theme: name: material features: