Permalink
Browse files

Update README

  • Loading branch information...
royclarkson committed Jan 4, 2013
1 parent 864f965 commit 6729b14cf015276444124b9f2e8804579cc5d14a
Showing with 44 additions and 15 deletions.
  1. +44 −15 README.md
View
@@ -1,8 +1,20 @@
# Spring Mobile
-[Spring Mobile](http://www.springsource.org/spring-mobile) is an extension to [Spring MVC](http://static.springsource.org/spring/docs/current/spring-framework-reference/html/mvc.html) that aims to simplify the development of mobile web applications.
+[Spring Mobile] is an extension to [Spring MVC] that aims to simplify the development of mobile web applications.
-## Check Out and Build from Source
+## Downloading artifacts
+See [downloading Spring artifacts] for Maven repository information. Unable to
+use Maven or other transitive dependency management tools? See [building a
+distribution with dependencies].
+
+## Documentation
+See the current [Javadoc] and [reference docs].
+
+## Issue Tracking
+Report issues via the [Spring Mobile JIRA]. Understand our issue management
+process by reading about [the lifecycle of an issue].
+
+## Build from Source
1. Clone the repository from GitHub:
@@ -12,32 +24,49 @@
$ cd spring-mobile
-3. The project uses [Gradle](http://gradle.org/) to build:
+3. The project uses [Gradle] to build:
$ ./gradlew build
+
+4. Install jars into your local Maven cache (optional)
+
+ $ ./gradlew install
-## Eclipse
+## Import Source into your IDE
-To generate Eclipse metadata (.classpath and .project files), use the following Gradle task:
+### Eclipse
+
+To generate Eclipse metadata (.classpath and .project files):
$ ./gradlew eclipse
Once complete, you may then import the projects into Eclipse as usual:
File -> Import -> Existing projects into workspace
-Alternatively, [SpringSource Tool Suite](http://www.springsource.com/developer/sts) has built in support for [Gradle](http://gradle.org/), and you can simply import as Gradle projects.
+Alternatively, [SpringSource Tool Suite] has built in support for [Gradle], and you can simply import as Gradle projects.
-## IDEA
+### IDEA
-To generate IDEA metadata (.iml and .ipr files), use the following Gradle task:
+Generate IDEA metadata (.iml and .ipr files):
$ ./gradlew idea
-## JavaDoc
-
-Use the following Gradle task to build the JavaDoc
-
- $ ./gradlew :docs:api
-
-_Note: The result will be available in 'docs/build/api'._
+## Contributing
+[Pull requests] are welcome. See the [contributor guidelines] for details.
+
+## License
+Spring Mobile is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
+
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Spring MVC]: http://static.springsource.org/spring/docs/current/spring-framework-reference/html/mvc.html
+[downloading Spring artifacts]: https://github.com/SpringSource/spring-framework/wiki/Downloading-Spring-artifacts
+[building a distribution with dependencies]: https://github.com/SpringSource/spring-framework/wiki/Building-a-distribution-with-dependencies
+[Javadoc]: http://static.springsource.org/spring-mobile/docs/1.1.x/api/
+[reference docs]: http://static.springsource.org/spring-mobile/docs/1.1.x/reference/html/
+[Spring Mobile JIRA]: http://jira.springsource.org/browse/MOBILE
+[the lifecycle of an issue]: https://github.com/cbeams/spring-framework/wiki/The-Lifecycle-of-an-Issue
+[Gradle]: http://gradle.org
+[SpringSource Tool Suite]: http://www.springsource.com/developer/sts
+[Pull requests]: http://help.github.com/send-pull-requests
+[contributor guidelines]: https://github.com/SpringSource/spring-mobile/wiki/Contributor-Guidelines

0 comments on commit 6729b14

Please sign in to comment.