From 9992d10462e08d86d50c11334fff9eb4688fba91 Mon Sep 17 00:00:00 2001 From: Mark Pollack Date: Wed, 18 Jul 2012 00:38:45 -0400 Subject: [PATCH] SHL-46 - Update github readme.md --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c8d2847e..207f86b4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ The Spring Shell project provides an extensible interactive shell enviornment with a simple Spring based plugin model. -This is essentially a place holder README file until this project gets its sealegs. +# Docs + +You can find out more details from the [user documentation](http://static.springsource.org/spring-shell/docs/current/reference/) or by browsing the [javadocs](http://static.springsource.org/spring-shell/docs/current/api/). If you have ideas about how to improve or extend the scope, please feel free to contribute. -* Maven: +# Artifacts ~~~~~ xml @@ -40,7 +42,10 @@ dependencies { compile "org.springframework.shell:spring-shell:${version}" } ~~~~~ -current version is 1.0.0.BUILD-SNAPSHOT + +The latest milestone is _1.0.0.M1_ + +The latest nightly is _1.0.0.BUILD-SNAPSHOT_ # Building Spring Shell is built with Gradle. To build Spring Shell, run @@ -50,8 +55,10 @@ Spring Shell is built with Gradle. To build Spring Shell, run # Running Example cd samples/helloworld - ../../gradlew - java -jar build/libs/helloworld-1.0.0.BUILD-SNAPSHOT.jar + ../../gradlew installApp + cd build/install/helloworld/bin + helloworld + # Contributing @@ -60,6 +67,4 @@ Here are some ways for you to get involved in the community: * Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?f=80) by responding to questions and joining the debate. Please add 'Hadoop' as a prefix to easily spot the post topic. * Create [JIRA](https://jira.springframework.org/browse/SHL) tickets for bugs and new features and comment and vote on the ones that you are interested in. -* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org - Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a tracker ticket as well covering the specific issue you are addressing. Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.