Merge pull request #29827 from gsmet/template-readme

Improve header in README.md based on name and description
quarkusio · Dec 21, 2022 · 0193983 · 0193983
2 parents bdbdebd + b44cc34
commit 0193983
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/...s/src/main/resources/codestarts/quarkus/project/quarkus/base/README.tpl.qute.md b/...s/src/main/resources/codestarts/quarkus/project/quarkus/base/README.tpl.qute.md
@@ -1,4 +1,13 @@
-# {project.artifact-id} Project
+{#if readme.include-default-content}
+{#if project.name}
+# {project.name}
+{#else}
+# {project.artifact-id}
+{/if}
+{#if project.description}
+
+> {project.description}
+{/if}
 
 This project uses Quarkus, the Supersonic Subatomic Java Framework.
 
@@ -60,3 +69,4 @@ If you want to learn more about building native executables, please consult {bui
 
 ## Provided Code
 {/if}
+{/if}
diff --git a/...tools/base-codestarts/src/main/resources/codestarts/quarkus/project/quarkus/codestart.yml b/...tools/base-codestarts/src/main/resources/codestarts/quarkus/project/quarkus/codestart.yml
@@ -25,5 +25,7 @@ language:
         artifact-id: quarkus-project
         version: 1.0.0-SNAPSHOT
         package-name: org.acme
+      readme:
+        include-default-content: true
     dependencies:
       - io.quarkus:quarkus-arc
diff --git a/...esources/__snapshots__/QuarkusCodestartGenerationTest/generateDefault/README.md b/...esources/__snapshots__/QuarkusCodestartGenerationTest/generateDefault/README.md
@@ -1,4 +1,4 @@
-# test-codestart Project
+# test-codestart
 
 This project uses Quarkus, the Supersonic Subatomic Java Framework.