Add skeleton docs

This commit is contained in:
Dave Syer
2014-09-29 10:55:45 +01:00
parent 6db8a87d81
commit ead353fca4
2 changed files with 45 additions and 0 deletions

11
Guardfile Normal file
View File

@@ -0,0 +1,11 @@
require 'asciidoctor'
require 'erb'
options = {:mkdirs => true, :safe => :unsafe, :attributes => 'linkcss'}
guard 'shell' do
watch(/^[A-Za-z].*\.adoc$/) {|m|
Asciidoctor.render_file('src/main/adoc/README.adoc', options.merge(:to_file => './README.md'))
Asciidoctor.render_file('src/main/adoc/spring-cloud-cli.adoc', options.merge(:to_dir => 'target/docs'))
}
end

View File

@@ -0,0 +1,34 @@
Spring Boot command line features for
[Spring Cloud](https://github.com/spring-cloud). To install, make
sure you have
[Spring Boot CLI](https://github.com/spring-projects/spring-boot)
(1.1.x with x>=5):
$ spring version
Spring CLI v1.1.5.RELEASE
E.g. for GVM users
```
$ gvm install springboot 1.1.5.RELEASE
$ gvm use springboot 1.1.5.RELEASE
```
then get the install command plugin (backported from Boot 1.2.0):
```
$ wget http://dl.bintray.com/dsyer/generic/install-0.0.1.jar
```
install it in the Spring Boot CLI, e.g. with GVM (MacOS users that rely on brew might have to find the `/lib` directory by scanning `brew info springboot`):
```
$ cp install-0.0.1.jar ~/.gvm/springboot/1.1.5.RELEASE/lib
```
and finally install the Spring Cloud plugin:
```
$ mvn install
$ spring install org.springframework.cloud:spring-cloud-cli:1.0.0.BUILD-SNAPSHOT
```