docs: update to languages to contain proper information and added (Html,
Rust)
This commit is contained in:
+3
-21
@@ -1,26 +1,9 @@
|
|||||||
### C Setup for Polydev 🛠️
|
### **Build**
|
||||||
|
|
||||||
#### Keybinds 🎮
|
|
||||||
You can customize keybinds for your C projects with Polydev.
|
|
||||||
|
|
||||||
| Keybind | Action |
|
|
||||||
|---------------------|--------------------------------------------------|
|
|
||||||
| `<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
|
```lua
|
||||||
require("Polydev").c.setup({
|
-- Adds build attributes when compiling if you need extra arguments
|
||||||
keybinds = {
|
build_attributes = ""
|
||||||
["<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:
|
This is the recommended file structure for your C projects using Polydev:
|
||||||
|
|
||||||
@@ -50,5 +33,4 @@ Projects/
|
|||||||
└── include/
|
└── include/
|
||||||
└── *.h
|
└── *.h
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
+3
-19
@@ -1,24 +1,8 @@
|
|||||||
### C Setup for Polydev 🛠️
|
### Build
|
||||||
|
|
||||||
#### Keybinds 🎮
|
|
||||||
You can customize keybinds for your C projects with Polydev.
|
|
||||||
|
|
||||||
| Keybind | Action |
|
|
||||||
|---------------------|--------------------------------------------------|
|
|
||||||
| `<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
|
```lua
|
||||||
require("Polydev").c.setup({
|
-- Adds build attributes when compiling if you need extra arguments
|
||||||
keybinds = {
|
build_attributes = ""
|
||||||
["<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 📂
|
#### File Structure 📂
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
Nothing here yet! Html is supported however!
|
||||||
+2
-26
@@ -1,28 +1,4 @@
|
|||||||
### Java Setup for Polydev ☕️
|
### **Java Features**
|
||||||
|
|
||||||
#### Keybinds 🎮
|
|
||||||
You can customize the keybinds for your Java projects in Polydev.
|
|
||||||
|
|
||||||
| Keybind | Action |
|
|
||||||
|---------------------|-----------------------------------------------------|
|
|
||||||
| `<leader>pr` | Run `Main.java` from the `out` folder in your project |
|
|
||||||
| `<leader>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 = {
|
|
||||||
["<leader>pr"] = "JavaRun", -- Run Main.java in the out folder
|
|
||||||
["<leader>nf"] = "NewJavaFile" -- Create a new Java file in the src folder
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Java Features ✨
|
|
||||||
|
|
||||||
* **Java Build and Run**:
|
* **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.
|
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:
|
Here’s the recommended structure for your Java projects using Polydev:
|
||||||
|
|
||||||
| Directory/File Path | Description |
|
| Directory/File Path | Description |
|
||||||
|
|||||||
+1
-32
@@ -1,35 +1,4 @@
|
|||||||
### Lua Setup for Polydev 🐢
|
### **Lua Features**
|
||||||
|
|
||||||
#### Key Notes ⚠️
|
|
||||||
|
|
||||||
* Polydev provides seamless integration with Lua projects, allowing you to easily run and manage Lua code.
|
|
||||||
* You must include a `<Project_name>.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 |
|
|
||||||
|---------------------|-------------------------------------------------|
|
|
||||||
| `<leader>pr` | Run the Lua project |
|
|
||||||
|
|
||||||
##### Configuration Example:
|
|
||||||
|
|
||||||
```lua
|
|
||||||
-- These are the defaults for Lua, adjust as needed
|
|
||||||
require("Polydev").lua.setup({
|
|
||||||
keybinds = {
|
|
||||||
["<leader>pr"] = "LuaRun", -- Run the Lua project
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Lua Features ✨
|
|
||||||
|
|
||||||
* **Run Lua Projects**:
|
* **Run Lua Projects**:
|
||||||
Easily run your Lua project from within your terminal using the `<leader>pr` keybind. This automatically runs your `init.lua` or the entry point of your Lua code.
|
Easily run your Lua project from within your terminal using the `<leader>pr` keybind. This automatically runs your `init.lua` or the entry point of your Lua code.
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
Nothing here yet! Rust is supported however!
|
||||||
@@ -43,7 +43,6 @@ M.defaults = {
|
|||||||
["<leader>pr"] = "CRun",
|
["<leader>pr"] = "CRun",
|
||||||
["<leader>nh"] = "NewCHeaderFile",
|
["<leader>nh"] = "NewCHeaderFile",
|
||||||
},
|
},
|
||||||
build_attributes = ""
|
|
||||||
},
|
},
|
||||||
cpp = {
|
cpp = {
|
||||||
project_root = "~/Projects/Cpp",
|
project_root = "~/Projects/Cpp",
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ nav:
|
|||||||
- Cpp: languages/cpp.md
|
- Cpp: languages/cpp.md
|
||||||
- Lua: languages/lua.md
|
- Lua: languages/lua.md
|
||||||
- Python: languages/python.md
|
- Python: languages/python.md
|
||||||
|
- Rust: languages/rust.md
|
||||||
|
- Html: languages/html.md
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
features:
|
features:
|
||||||
|
|||||||
Reference in New Issue
Block a user