git/jws
1
0
Fork 0
Code Issues Pull requests Projects Releases 8 Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
Patryk Hegenberg 2025-03-15 00:15:56 +01:00
parent 09b1054588
commit 2c4a3be0b8
1 changed files with 10 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -3,13 +3,14 @@
This application is a GUI tool developed in Go using the Fyne framework (v2.5.4). It helps users set up a development environment for JakartaEE and Spring Boot projects by checking and installing necessary dependencies, and then allowing users to deploy starter projects. This application is a GUI tool developed in Go using the Fyne framework (v2.5.4). It helps users set up a development environment for JakartaEE and Spring Boot projects by checking and installing necessary dependencies, and then allowing users to deploy starter projects.
## Features ## Features
- *Dependency Check*: Verifies the installation of required tools (Visual Studio Code and Docker).
- *Automatic Installation*: Offers to install missing dependencies on supported platforms. - _Dependency Check_: Verifies the installation of required tools (Visual Studio Code and Docker).
- *Project Selection*: Provides a list of starter projects for JakartaEE and Spring Boot. - _Automatic Installation_: Offers to install missing dependencies on supported platforms.
- *Project Deployment*: Allows users to deploy selected projects and open them in Visual Studio Code with dev containers. - _Project Selection_: Provides a list of starter projects for JakartaEE and Spring Boot.
- _Project Deployment_: Allows users to deploy selected projects and open them in Visual Studio Code with dev containers.
## Prerequisites ## Prerequisites
@ -30,13 +31,13 @@ Download the appropriate binary for your operating system.
- Clone the repository: - Clone the repository:
```bash ```bash
git clone https://github.com/yourusername/jakartaee-springboot-starter.git git clone https://github.com/yourusername/jws_gui.git
``` ```
Navigate to the project directory: Navigate to the project directory:
```bash ```bash
cd jakartaee-springboot-starter cd jws_gui
``` ```
Install dependencies: Install dependencies:
@ -52,6 +53,7 @@ Build the application:
```bash ```bash
go build go build
``` ```
## Usage ## Usage
Run the application: Run the application:
@ -76,12 +78,9 @@ The application will launch a GUI window where you can:
2. Select a starter project from the available options. 2. Select a starter project from the available options.
3. Deploy the selected project and open it in Visual Studio Code. 3. Deploy the selected project and open it in Visual Studio Code.
Project Structure ## Project Structure
// TODO _TODO_
- main.go: Contains the entire application logic, including GUI setup, dependency checking, and project deployment.
- projects/: Directory containing starter project templates.
- projects.json: Configuration file for additional plugin projects.
## Customization ## Customization