From f0ad550410e80d30c24f8e45c434aaed1427f893 Mon Sep 17 00:00:00 2001 From: "Matteo Franci a.k.a. Fugerit" Date: Tue, 10 Sep 2024 01:53:02 +0200 Subject: [PATCH] Improved readme --- .../doc/project/facade/FlavourContext.java | 4 +--- .../template/flavour/micronaut-4/README.ftl | 20 +++++++++++++++++++ .../template/flavour/quarkus-3/README.ftl | 18 +++++++++++++++++ 3 files changed, 39 insertions(+), 3 deletions(-) diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java index bd2e0cf6b..3fe0a6fe7 100644 --- a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java +++ b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/FlavourContext.java @@ -37,9 +37,7 @@ private String toClassName( String base, String splitString ) { StringBuilder buf = new StringBuilder(); String[] split = base.split( splitString ); for ( String part : split ) { - if ( part.length() > 0 ) { - buf.append( part.substring( 0, 1 ).toLowerCase()+part.substring( 1 ) ); - } + buf.append( part.substring( 0, 1 ).toLowerCase()+part.substring( 1 ) ); } return buf.toString(); } diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/micronaut-4/README.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/micronaut-4/README.ftl index e4106810c..bd87a9722 100644 --- a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/micronaut-4/README.ftl +++ b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/micronaut-4/README.ftl @@ -1,5 +1,25 @@ # ${context.artifactId} +## Quickstart + +Requirement : +- maven 3.9.x +- java ${context.javaRelease}+ + +1. Start the app + +```shell +mvn mn:run +``` + +2. Try the app + +Open the [openapi-explorer](http://localhost:8080/swagger/views/openapi-explorer) + +Test available routes (for instance : [/doc/example.md](http://localhost:8080/doc/example.md)) + +## Projects notes + the project used as template has been created with the command : ```shell diff --git a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3/README.ftl b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3/README.ftl index 6f52e943b..d3a4f8db5 100644 --- a/fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3/README.ftl +++ b/fj-doc-maven-plugin/src/main/resources/config/template/flavour/quarkus-3/README.ftl @@ -1,5 +1,23 @@ # ${context.artifactId} +## Quickstart + +Requirement : +- maven 3.9.x +- java ${context.javaRelease}+ + +1. Start the app + +```shell +mvn quarkus:dev +``` + +2. Try the app + +Open the [swagger-ui](http://localhost:8080/q/swagger-ui/) + +Test available paths (for instance : [/doc/example.md](http://localhost:8080/doc/example.md)) + ## Overview This project has been initialized using [fj-doc-maven-plugin init goal](https://venusguides.fugerit.org/src/docs/wizard/fj-doc-maven-plugin_init.html).