lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-07-17 01:46:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Polish modules description

Browse Source
This commit is contained in:
Stephane Nicoll 2019-03-17 11:34:04 +01:00
parent b80e3570d8
commit 9050056f24
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.adoc
View File

@ -30,8 +30,10 @@ The reference documentation is available in {docs}/html/[HTML format].
== Modules == Modules
Spring Initializr has the following modules: Spring Initializr has the following modules:
* `initializr-generator`: standalone project generation library that can be reused * `initializr-generator`: core project generation library
in many environments (including embedded in your own project) * `initializr-metadata`: metadata infrastructure for various aspects of the project
* `initializr-generator-spring`: optional module defining the conventions for a Spring
Boot project. Can be replaced by your own conventions if necessary.
* `initializr-web`: REST endpoints and web interface * `initializr-web`: REST endpoints and web interface
* `initializr-actuator`: optional module to provide additional information and statistics * `initializr-actuator`: optional module to provide additional information and statistics
on project generation on project generation

19
initializr-docs/src/main/asciidoc/configuration-guide.adoc
View File

@ -83,15 +83,14 @@ conditions can easily be created by inheriting from `ProjectGenerationCondition`
== Creating your own instance == Creating your own instance
Spring Initializr is split across several modules: Spring Initializr is split across several modules:
* `initializr-generator`: standalone project generation library that can be reused in * `initializr-generator`: core project generation library
many environments (including embedded in your own project) * `initializr-metadata`: metadata infrastructure for various aspects of the project
* `initializr-generator-spring`: contributors to generate a Spring-based project. This * `initializr-generator-spring`: optional module defining the conventions for a Spring
module is necessary if you want to generate the same project structure as the one Boot project. Can be replaced by your own conventions if necessary.
available on start.spring.io. Alternatively, you can roll-out your own opinions. * `initializr-web`: REST endpoints and web interface
* `initializr-metadata`: Configuration model.
* `initializr-web`: API endpoints and web interface
* `initializr-actuator`: optional module to provide additional information and statistics * `initializr-actuator`: optional module to provide additional information and statistics
on project generation on project generation
* `initializr-docs`: documentation
Because it contains several auto-configurations, creating your own instance is quite easy, Because it contains several auto-configurations, creating your own instance is quite easy,
actually you could get started using Spring Initializr itself to generate a starting point! actually you could get started using Spring Initializr itself to generate a starting point!
@ -105,6 +104,11 @@ Create a new project with the `web` dependency and add the following dependency:
<artifactId>initializr-web</artifactId> <artifactId>initializr-web</artifactId>
<version>{spring-initializr-version}</version> <version>{spring-initializr-version}</version>
</dependency> </dependency>
<dependency>
<groupId>io.spring.initializr</groupId>
<artifactId>initializr-generator-spring</artifactId>
<version>{spring-initializr-version}</version>
</dependency>
---- ----
Or if you are using Gradle: Or if you are using Gradle:
@ -112,6 +116,7 @@ Or if you are using Gradle:
[source,groovy,indent=0,subs="verbatim,quotes,attributes"] [source,groovy,indent=0,subs="verbatim,quotes,attributes"]
---- ----
implementation("io.spring.initializr:initializr-web:{spring-initializr-version}") implementation("io.spring.initializr:initializr-web:{spring-initializr-version}")
implementation("io.spring.initializr:initializr-generator-spring:{spring-initializr-version}")
---- ----
NOTE: Spring Initializr releases are not available on Maven Central so you will need to NOTE: Spring Initializr releases are not available on Maven Central so you will need to