Updated language docs
This commit is contained in:
+41
-6
@@ -1,16 +1,49 @@
|
||||
## Keybinds
|
||||
### Java Setup for Polydev ☕️
|
||||
|
||||
#### Keybinds 🎮
|
||||
You can customize the keybinds for your Java projects in Polydev.
|
||||
|
||||
| Keybind | Action |
|
||||
|---------------------|-----------------------------------------------------|
|
||||
| `<leader>pb` | Build all Java files in the `src` directory |
|
||||
| `<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 = {
|
||||
["<Esc>"] = "CloseTerminal" -- Closes terminal, esc by default.
|
||||
["<leader>pb"] = "JavaBuild" -- Building all Java Files in src directory in.
|
||||
["<leader>pr"] = "JavaRun" -- Runs Main.java in the out folder in your project_root
|
||||
["<leader>nf"] = "NewJavaFile" -- Creates a new Java file in the current project src folder
|
||||
["<leader>pb"] = "JavaBuild", -- Build all Java files in the src directory
|
||||
["<leader>pr"] = "JavaRun", -- Run Main.java in the out folder
|
||||
["<leader>nf"] = "NewJavaFile" -- Create a new Java file in the src folder
|
||||
}
|
||||
})
|
||||
```
|
||||
## File Structure
|
||||
|
||||
---
|
||||
|
||||
#### 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.
|
||||
|
||||
* **Project File Management**:
|
||||
The plugin manages your Java project files efficiently, helping you quickly add new Java files to the `src` directory. It also ensures that your build and run processes are streamlined.
|
||||
|
||||
---
|
||||
|
||||
#### File Structure 📂
|
||||
Here’s the recommended structure for your Java projects using Polydev:
|
||||
|
||||
| Directory/File Path | Description |
|
||||
|----------------------------|------------------------------------------------------|
|
||||
| `src/` | Contains the source code files, including `Main.java` |
|
||||
| `build/` | Contains compiled `.class` files |
|
||||
| `Main.java` | The main entry point of your Java project |
|
||||
|
||||
#### Example Structure:
|
||||
|
||||
```md
|
||||
Projects/
|
||||
@@ -21,3 +54,5 @@ Projects/
|
||||
└── build/
|
||||
└── *.class
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user