From 3942f88ef6afde0b07cb0669303c18e7e76342ef Mon Sep 17 00:00:00 2001 From: DarthMooMancer <107283522+DarthMooMancer@users.noreply.github.com> Date: Fri, 16 May 2025 01:01:11 -0400 Subject: [PATCH] docs(languages): removed individual language files and moved them all to one --- docs/languages.md | 150 +++++++++++++++++++++++++++++++++++++++ docs/languages/c.md | 30 -------- docs/languages/cpp.md | 31 -------- docs/languages/html.md | 1 - docs/languages/java.md | 32 --------- docs/languages/lua.md | 31 -------- docs/languages/python.md | 40 ----------- docs/languages/rust.md | 1 - 8 files changed, 150 insertions(+), 166 deletions(-) create mode 100644 docs/languages.md delete mode 100644 docs/languages/c.md delete mode 100644 docs/languages/cpp.md delete mode 100644 docs/languages/html.md delete mode 100644 docs/languages/java.md delete mode 100644 docs/languages/lua.md delete mode 100644 docs/languages/python.md delete mode 100644 docs/languages/rust.md diff --git a/docs/languages.md b/docs/languages.md new file mode 100644 index 0000000..55d7010 --- /dev/null +++ b/docs/languages.md @@ -0,0 +1,150 @@ +## Java + +#### Structure Reference + +| 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 | + +#### Project Layout + +```md +Projects/ +└── Java/ + └── Project_Name/ + ├── src/ + │ └── Main.java + └── build/ + └── *.class +``` + +--- + +## C + +#### Structure Reference + +| 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 | +| `include/` | Folder for header files | +| `*.h` | C header files | + +#### Project Layout + +```md +Projects/ +└── C/ + └── Project_Name/ + ├── CMakeLists.txt + ├── src/ + │ ├── main.c + │ └── *.c + ├── build/ + │ └── + │ └── + └── include/ + └── *.h +``` + +--- + +## C++ + +#### Structure Reference + +| 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 | +| `include/` | Folder for header files | +| `*.hpp` | Cpp header files | + +#### Project Layout + +```md +Projects/ +└── Cpp/ + └── Project_Name/ + ├── CMakeLists.txt + ├── src/ + │ ├── main.cpp + │ └── *.cpp + ├── build/ + │ └── + │ └── + └── include/ + └── *.hpp +``` + +--- + +## Lua + +#### Structure Reference + +| Directory/File Path | Description | +|----------------------------|-----------------------------------------------------| +| `lua/` | Directory containing the main Lua project files | +| `lua//init.lua` | The main entry point for your Lua project | + +#### Project Layout + +```md +Projects/ +└── Lua/ + └── Project_Name/ + └── lua/ + └── Project_name/ + └── init.lua -- Main Lua file +``` + +--- + +## Python + +- **Automatic Virtual Environment Creation**: Each Python project automatically sets up and uses a new virtual environment. You don’t need to worry about environment management. Just install your dependencies with `pip` as needed. + +- **Dependency Management with Pip**: Need to install Python modules? Simply type the name of the module in the terminal, and Polydev will take care of the installation using `pip`. You can even update `pip` if required, ensuring smooth installation. + +#### Structure Reference + +| Directory/File Path | Description | +|----------------------------|------------------------------------------------------| +| `requirements.txt` | File for listing project dependencies | +| `setup.py` | Python project setup file | +| `tests/` | Folder containing test files | +| `venv/` | Virtual environment folder | +| `main.py` | Main Python file for your project | + +#### Project Layout + +```md +Projects/ +└── Python/ + └── Project_Name/ + ├── main.py + ├── requirements.txt + ├── setup.py + ├── tests/ + └── venv/ +``` + +--- + +## Html + +Nothing here yet! Html is supported however! Will do later + +## Rust + +Nothing here yet! Rust is supported however! Will do later diff --git a/docs/languages/c.md b/docs/languages/c.md deleted file mode 100644 index 6178ffe..0000000 --- a/docs/languages/c.md +++ /dev/null @@ -1,30 +0,0 @@ -#### 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 | -| `include/` | Folder for header files | -| `*.h` | C header files | - -#### Example Structure: - -```md -Projects/ -└── C/ - └── Project_Name/ - ├── CMakeLists.txt - ├── src/ - │ ├── main.c - │ └── *.c - ├── build/ - │ └── - │ └── - └── include/ - └── *.h -``` ---- diff --git a/docs/languages/cpp.md b/docs/languages/cpp.md deleted file mode 100644 index 1c0cb1f..0000000 --- a/docs/languages/cpp.md +++ /dev/null @@ -1,31 +0,0 @@ -#### 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 | -| `include/` | Folder for header files | -| `*.hpp` | Cpp header files | - -#### Example Structure: - -```md -Projects/ -└── Cpp/ - └── Project_Name/ - ├── CMakeLists.txt - ├── src/ - │ ├── main.cpp - │ └── *.cpp - ├── build/ - │ └── - │ └── - └── include/ - └── *.hpp -``` - ---- diff --git a/docs/languages/html.md b/docs/languages/html.md deleted file mode 100644 index 1ee18d9..0000000 --- a/docs/languages/html.md +++ /dev/null @@ -1 +0,0 @@ -Nothing here yet! Html is supported however! diff --git a/docs/languages/java.md b/docs/languages/java.md deleted file mode 100644 index 7e95a4b..0000000 --- a/docs/languages/java.md +++ /dev/null @@ -1,32 +0,0 @@ -### **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/ -└── Java/ - └── Project_Name/ - ├── src/ - │ └── Main.java - └── build/ - └── *.class -``` - ---- diff --git a/docs/languages/lua.md b/docs/languages/lua.md deleted file mode 100644 index f76d6a3..0000000 --- a/docs/languages/lua.md +++ /dev/null @@ -1,31 +0,0 @@ -### **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. - -* **Create New Lua Files**: - With the `nf` keybind, you can quickly create new Lua files in the `src` directory, maintaining an organized project structure. - ---- - -#### File Structure 📂 - -Here’s the suggested directory structure for your Lua projects with Polydev: - -| Directory/File Path | Description | -|----------------------------|-----------------------------------------------------| -| `lua/` | Directory containing the main Lua project files | -| `lua//init.lua` | The main entry point for your Lua project | - -##### Example File Structure: - -```md -Projects/ -└── Lua/ - └── Project_Name/ - └── lua/ - └── Project_name/ - └── init.lua -- Main Lua file -``` - ---- diff --git a/docs/languages/python.md b/docs/languages/python.md deleted file mode 100644 index c1d2022..0000000 --- a/docs/languages/python.md +++ /dev/null @@ -1,40 +0,0 @@ -### **Python Features** - -Here are some cool features available for Python projects using Polydev: - -- **Automatic Virtual Environment Creation** 🔧 -Each Python project automatically sets up and uses a new virtual environment. You don’t need to worry about environment management. Just install your dependencies with `pip` as needed. - -- **Dependency Management with Pip** 📦 -Need to install Python modules? Simply type the name of the module in the terminal, and Polydev will take care of the installation using `pip`. You can even update `pip` if required, ensuring smooth installation. - -- **Effortless Dependency Handling** ⚡ -You no longer need to manually activate or deactivate virtual environments. With Polydev, the environment is set up and activated automatically, simplifying your workflow. - ---- - -#### **File Structure** -Here’s the recommended structure for your Python projects using Polydev: - -| Directory/File Path | Description | -|----------------------------|------------------------------------------------------| -| `requirements.txt` | File for listing project dependencies | -| `setup.py` | Python project setup file | -| `tests/` | Folder containing test files | -| `venv/` | Virtual environment folder | -| `main.py` | Main Python file for your project | - -#### **Tree Structure**: - -```md -Projects/ -└── Python/ - └── Project_Name/ - ├── main.py - ├── requirements.txt - ├── setup.py - ├── tests/ - └── venv/ -``` - ---- diff --git a/docs/languages/rust.md b/docs/languages/rust.md deleted file mode 100644 index a05c24b..0000000 --- a/docs/languages/rust.md +++ /dev/null @@ -1 +0,0 @@ -Nothing here yet! Rust is supported however!