From 40a9176937aeda9e7dff39e9a5b68c917dcf1a10 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 5 Aug 2013 17:58:18 -0700 Subject: [PATCH] Restructure distribution content Include LICENCE and INSTALL text files and ensure that .bat file is not set with executable Unix file permissions. --- .../src/main/assembly/descriptor.xml | 11 ++++-- spring-boot-cli/src/main/content/INSTALL.txt | 35 +++++++++++++++++++ spring-boot-cli/src/main/content/LICENCE.txt | 14 ++++++++ .../main/{scripts => content/bin}/spring.bat | 0 .../{scripts => executablecontent/bin}/spring | 0 5 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 spring-boot-cli/src/main/content/INSTALL.txt create mode 100644 spring-boot-cli/src/main/content/LICENCE.txt rename spring-boot-cli/src/main/{scripts => content/bin}/spring.bat (100%) rename spring-boot-cli/src/main/{scripts => executablecontent/bin}/spring (100%) diff --git a/spring-boot-cli/src/main/assembly/descriptor.xml b/spring-boot-cli/src/main/assembly/descriptor.xml index 6f6608bb6a..beac4ee7d0 100644 --- a/spring-boot-cli/src/main/assembly/descriptor.xml +++ b/spring-boot-cli/src/main/assembly/descriptor.xml @@ -9,8 +9,15 @@ true - src/main/scripts - bin + src/main/content + / + true + 644 + 755 + + + src/main/executablecontent + / true 755 755 diff --git a/spring-boot-cli/src/main/content/INSTALL.txt b/spring-boot-cli/src/main/content/INSTALL.txt new file mode 100644 index 0000000000..42d6045f81 --- /dev/null +++ b/spring-boot-cli/src/main/content/INSTALL.txt @@ -0,0 +1,35 @@ +SPRING BOOT CLI - INSTALLATION +============================== + +Thank you for downloading the Spring Boot CLI tool. Please follow these instructions +in order to complete your installation. + + +Prerequisites +------------- +Spring Boot CLI requires Java JDK v1.6 or above in order to run. Groovy v2.1 is packaged +as part of this distribution, and therefore does not need to be installed (any existing +Groovy installation is ignored). + +The CLI will use whatever JDK it finds on your path, to check that you have an appropriate +version you should run: + + java -version + +Alternatively, you can set the JAVA_HOME environment variable to point an suitable JDK. + + +Environment Variables +--------------------- +No specific environment variables are required to run the CLI, however, you may want to +set SPRING_HOME to point to a specific installation. You should also add SPRING_HOME/bin +to your PATH environment variable. + + +Checking Your Installation +-------------------------- +To test if you have successfully install the CLI you can run the following command: + + spring --version + + diff --git a/spring-boot-cli/src/main/content/LICENCE.txt b/spring-boot-cli/src/main/content/LICENCE.txt new file mode 100644 index 0000000000..78947af380 --- /dev/null +++ b/spring-boot-cli/src/main/content/LICENCE.txt @@ -0,0 +1,14 @@ +Copyright 2012-2013 the original author or authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + diff --git a/spring-boot-cli/src/main/scripts/spring.bat b/spring-boot-cli/src/main/content/bin/spring.bat similarity index 100% rename from spring-boot-cli/src/main/scripts/spring.bat rename to spring-boot-cli/src/main/content/bin/spring.bat diff --git a/spring-boot-cli/src/main/scripts/spring b/spring-boot-cli/src/main/executablecontent/bin/spring similarity index 100% rename from spring-boot-cli/src/main/scripts/spring rename to spring-boot-cli/src/main/executablecontent/bin/spring