diff --git a/README.md b/README.md index 604fa70302..9141f4280f 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ An `alias` can be used for the Spring Zero command line tool: $ alias spr="java -jar ~/.m2/repository/org/springframework/zero/spring-cli/0.5.0.BUILD-SNAPSHOT/spring-cli-0.5.0.BUILD-SNAPSHOT.jar" -_Also see [CONTRIBUTING.md](/CONTRIBUTING.md) if you want to submit pull requests._ +_Also see [docs/CONTRIBUTING](docs/CONTRIBUTING.md) if you want to submit pull requests._ ## Quick Start Example @@ -102,7 +102,7 @@ The 'spring' command line application compiles and runs Groovy source, making it easy to write the absolute minimum of code to get an application running. Spring CLI can also watch files, automatically recompiling and restarting when they change. -*See [spring-cli/README.md](spring-cli/README.md).* +*See [spring-cli/README](spring-cli/README.md).* ### Spring Bootstrap @@ -115,7 +115,7 @@ Features include: * Embedded web applications with a choice of container (Tomcat or Jetty for now) * First class externalized configuration support -_See [spring-bootstrap/README.md](spring-bootstrap/README.md)._ +_See [spring-bootstrap/README](spring-bootstrap/README.md)._ ### Spring Autoconfigure @@ -128,7 +128,7 @@ classpath. For example, If a 'HSQLDB' is on the classpath the user probably want in-memory database to be defined. Auto-configuration will back away as the user starts to define their own beans. -_See [spring-autoconfigure/README.md](spring-autoconfigure/README.md)._ +_See [spring-autoconfigure/README](spring-autoconfigure/README.md)._ ### Spring Actuator @@ -138,7 +138,7 @@ writing a JSON web service then it will provide a server, security, logging, ext configuration, management endpoints, an audit abstraction, and more. If you want to switch off the built in features, or extend or replace them, it makes that really easy as well. -_See [spring-actuator/README.md](spring-actuator/README.md)._ +_See [spring-actuator/README](spring-actuator/README.md)._ ### Spring Starters @@ -148,7 +148,7 @@ that you need without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access just include one dependency in your project, and you are good to go. -_See [spring-starters/README.md](spring-starters/README.md)._ +_See [spring-starters/README](spring-starters/README.md)._ ### Packaging @@ -157,16 +157,16 @@ The [spring-launcher](spring-launcher/) and to package you application for release. Applications can be released as a single jar file that can simply be launched using `java -jar`. -_See [spring-launcher/README.md](spring-launcher/README.md) & -[spring-package-maven-plugin/README.md](spring-package-maven-plugin/README.md)._ +_See [spring-launcher/README](spring-launcher/README.md) & +[spring-package-maven-plugin/README](spring-package-maven-plugin/README.md)._ ## Samples Groovy samples for use with the command line application are available in -[spring-cli/samples](spring-cli/samples/). To run the CLI samples type +[spring-cli/samples](spring-cli/samples/#). To run the CLI samples type `spr run .groovy` from samples directory. -Java samples are available in [spring-zero-sample](spring-zero-samples/) and should +Java samples are available in [spring-zero-sample](spring-zero-samples/#) and should be build with maven and run use `java -jar target/.jar`. The following java samples are provided: diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 90% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 67b20de8e0..d872b1ffce 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -62,9 +62,11 @@ Maven is well supported by most Java IDEs. Refer to you vendor documentation. ### Integration tests -The sample application are used as integration tests during the build. Due to the -fact that they make use of the `spring-package-maven-plugin` they cannot be called -directly, and so instead are launched via the `maven-invoker-plugin`. If you encounter -build failures running the integration tests, check the `build.log` file in the appropriate -sample directory. - \ No newline at end of file + +The sample application are used as integration tests during the build +(when you `mvn install`). Due to the fact that they make use of the +`spring-package-maven-plugin` they cannot be called directly, and so +instead are launched via the `maven-invoker-plugin`. If you encounter +build failures running the integration tests, check the `build.log` +file in the appropriate sample directory. + diff --git a/spring-launcher/README.md b/spring-launcher/README.md index e0ca6a1cb0..707ed067e3 100644 --- a/spring-launcher/README.md +++ b/spring-launcher/README.md @@ -1 +1,5 @@ # Spring Launcher + +A very thin Java main for executable JAR and WAR +archives. `JarLauncher` and `WarLauncher` know how to access classpath +resources and dependencies in nested jar files. diff --git a/spring-package-maven-plugin/README.md b/spring-package-maven-plugin/README.md index 3565a320cf..2d8ae89169 100644 --- a/spring-package-maven-plugin/README.md +++ b/spring-package-maven-plugin/README.md @@ -1 +1,22 @@ # Spring Package Maven Plugin + +A maven plugin for building executable JAR and WAR files. To use it +configure your project to build a JAR or WAR (as appropriate) in the +normal way, using the `maven-jar-plugin` or `maven-war-plugin`, and +then add the Spring plugin to your `` section + +`pom.xml` +```xml + + org.springframework.zero + spring-package-maven-plugin + {{project.version}} + + + + package + + + + +``` diff --git a/spring-starters/README.md b/spring-starters/README.md index 62e48700b1..649e2a838b 100644 --- a/spring-starters/README.md +++ b/spring-starters/README.md @@ -1 +1,4 @@ # Spring Starters + +Aggregated dependencies for starter projects with an opinionated +choice of Spring and related useful technologies. diff --git a/spring-starters/pom.xml b/spring-starters/pom.xml index 53af6e08c9..151f0ee0ea 100644 --- a/spring-starters/pom.xml +++ b/spring-starters/pom.xml @@ -40,7 +40,7 @@ false - #{*} + @{*} diff --git a/spring-starters/src/main/parent/pom.xml b/spring-starters/src/main/parent/pom.xml index 8351945e40..2a076a8b1f 100644 --- a/spring-starters/src/main/parent/pom.xml +++ b/spring-starters/src/main/parent/pom.xml @@ -13,7 +13,7 @@ UTF-8 UTF-8 4.0.0.BUILD-SNAPSHOT - #{project.version} + @{project.version} 3.0