Skip to content

Commit

Permalink
docs: Add jsgenerator-desktop documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FanJups committed Sep 19, 2024
1 parent b62aec7 commit 918b105
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 7 deletions.
3 changes: 3 additions & 0 deletions README.desktop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
> Screenshot of the current desktop version:
>
> ![Screenshot of the current desktop version](illustrations/screenshot_current_desktop_version.png)
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,14 @@ js-generator:
## Architecture

| THE MODULE | ITS CONTENT && DEPENDENCIES | PACKAGING |
|------------------------------------|-------------------------------------|-----------|
| js-generator | Bill of Material, global properties | POM |
| jsgenerator-core | Core API, Spring Boot auto-conf | JAR |
| jsgenerator-slim-api | jsgenerator-core, spring-web | JAR |
| jsgenerator-slim-cli | jsgenerator-core, picocli | JAR |
| [jsgenerator-api](./README.api.md) | jsgenerator-slim-api | FAT JAR |
| [jsgenerator-cli](./README.cli.md) | jsgenerator-slim-cli | FAT JAR |
|------------------------------------|-------------------------------------|-------|
| js-generator | Bill of Material, global properties | POM |
| jsgenerator-core | Core API, Spring Boot auto-conf | JAR |
| jsgenerator-slim-api | jsgenerator-core, spring-web | JAR |
| jsgenerator-slim-cli | jsgenerator-core, picocli | JAR |
| [jsgenerator-api](./README.api.md) | jsgenerator-slim-api | FAT JAR |
| [jsgenerator-cli](./README.cli.md) | jsgenerator-slim-cli | FAT JAR |
| [jsgenerator-desktop](./README.desktop.md) | jsgenerator-core, javafx-fxml | JAR |

> **NOTE:** FAT JAR packaged modules are mere wrappers around slim modules. The separation is important because then,
> the test modules can use slim JARs as dependencies, unlike FAT JARs. This has to do with how "normal" vs. FAT JARs
Expand Down Expand Up @@ -123,6 +124,16 @@ java -jar jsgenerator-cli/target/jsgenerator-cli-{version}.jar # java -jar jsgen
java -jar jsgenerator-cli/target/jsgenerator-cli-{version}.jar --tty --inline '<div>I am a <strong>tea pot</strong></div>'
```

Desktop : [jsgenerator-desktop](./README.desktop.md)
```shell
# Create the jar first
mvn clean package

# then run this command and replace {version} by the current one (0.0.1-SNAPSHOT at this time)
java -jar jsgenerator-desktop/target/jsgenerator-desktop-{version}.jar # java -jar jsgenerator-desktop/target/jsgenerator-desktop-0.0.1-SNAPSHOT.jar
```


## Packaging

```shell
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 918b105

Please sign in to comment.