Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README files

  • Loading branch information...
commit d84b2c985783fe304f06f89fb9232e9d6867e57b 1 parent 6810408
@royclarkson royclarkson authored
View
47 README.md
@@ -1,32 +1,51 @@
# Spring Mobile Samples
-## Overview
+[Spring Mobile] is an extension to [Spring MVC] that aims to simplify the development of mobile web applications. This repository contains sample projects illustrating usage of Spring Mobile. See [Spring Mobile on GitHub] for more information about building from source.
-This repository contains sample projects illustrating usage of the [Spring Mobile](http://www.springsource.org/spring-mobile) project.
-## Sample Apps
+## Sample Applications
-The following "lite" sample apps demonstrate the capabilities of the Spring Mobile LiteDeviceResolver for server-side device detection. See the README in each directory for more information on the sample project and additional instructions.
+The following sample applications demonstrate the capabilities of [Spring Mobile] for server-side device detection and handling. See the README within each sample project directory for more information and additional instructions.
-* **lite-device-resolver** - illustrates DeviceResolver functionality and usage.
+* [lite-device-resolver] - illustrates DeviceResolver functionality and usage.
-* **lite-site-preference-handler** - illustrates SitePreferenceHandler functionality.
+* [lite-site-preference-handler] - illustrates SitePreferenceHandler functionality.
-* **lite-site-switcher-handler** - illustrates SiteSwitcherHandler functionality.
+* [lite-site-switcher-handler] - illustrates SiteSwitcherHandler functionality.
-* **lite-device-delegating-view-resolver** - example showing view names adjusted based on device.
+* [lite-device-delegating-view-resolver] - example showing view names adjusted based on device.
-* **lite-showcase** - combines all features of Spring Mobile to showcase the use of the "urlPath" site switching.
+* [lite-showcase] - combines all features of Spring Mobile to showcase the use of the "urlPath" site switching.
-* **thorax-lumbar-client** - showcases the use of Spring Mobile with JavaScript libraries
+* [thorax-lumbar-client] - showcases the use of Spring Mobile with JavaScript libraries
-## Contributor Guidelines
-Please follow the [contributor guidelines](https://github.com/SpringSource/spring-mobile/wiki/Contributor-Guidelines) from Spring Mobile when submitting pull requests for the sample projects.
+## Contributing
+
+[Pull requests] are welcome. See the [contributor guidelines] for details.
+
## Additional Resources
-* [Screencast demonstration based on Spring Mobile 1.0.0.M2](http://s3.springsource.org/MVC/spring-mobile-1.0.0.M2-screencast.mov)
+See a [screencast demonstration] based on [Spring Mobile 1.0.0.M2].
+
## License
-Spring Mobile is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Spring MVC]: http://static.springsource.org/spring/docs/current/spring-framework-reference/html/mvc.html
+[Spring Mobile on GitHub]: https://github.com/SpringSource/spring-mobile
+[lite-device-resolver]: https://github.com/SpringSource/spring-mobile-samples/tree/master/lite-device-resolver
+[lite-site-preference-handler]: https://github.com/SpringSource/spring-mobile-samples/tree/master/lite-site-preference-handler
+[lite-site-switcher-handler]: https://github.com/SpringSource/spring-mobile-samples/tree/master/lite-site-switcher-handler
+[lite-device-delegating-view-resolver]: https://github.com/SpringSource/spring-mobile-samples/tree/master/lite-device-delegating-view-resolver
+[lite-showcase]: https://github.com/SpringSource/spring-mobile-samples/tree/master/lite-showcase
+[thorax-lumbar-client]: https://github.com/SpringSource/spring-mobile-samples/tree/master/thorax-lumbar-client
+[Pull requests]: http://help.github.com/send-pull-requests
+[contributor guidelines]: https://github.com/SpringSource/spring-mobile/wiki/Contributor-Guidelines
+[screencast demonstration]: http://s3.springsource.org/MVC/spring-mobile-1.0.0.M2-screencast.mov
+[Spring Mobile 1.0.0.M2]: http://www.springsource.org/spring-mobile/news/1.0.0.m2-released
+[Apache license]: http://www.apache.org/licenses/LICENSE-2.0
View
19 lite-device-delegating-view-resolver/README.md
@@ -1,14 +1,12 @@
-# Spring Mobile Lite Device Delegating View Resolver
+# lite-device-delegating-view-resolver
-## Overview
-
-This sample app demonstrates many of the capabilities of the Spring Mobile Device module, including:
+A [Spring Mobile] sample app demonstrating many of the capabilities of the Spring Mobile Device module, including:
* "Lite" device resolution through the use of DeviceResolverHandlerInterceptor
* Site preference management
* View resolution with LiteDeviceDelegatingViewResolver
-## Build and Run the Sample Application
+## Build and Deploy
1. Build the app:
@@ -22,6 +20,15 @@ This sample app demonstrates many of the capabilities of the Spring Mobile Devic
3. Access the project at the following URL:
- http://localhost:8080/lite-device-delegating-view-resolver
+ [http://localhost:8080/lite-device-delegating-view-resolver]
_Note: Accessing this URL from your browser versus an Android emulator or iOS simulator will demonstrate the functionality_
+
+
+## License
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+[http://localhost:8080/lite-device-delegating-view-resolver]: http://localhost:8080/lite-device-delegating-view-resolver
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
View
19 lite-device-resolver/README.md
@@ -1,10 +1,9 @@
-# Spring Mobile Lite Device Resolver
+# lite-device-resolver
-## Overview
+A [Spring Mobile] sample app demonstrating the Device Resolver capabilities of the Spring Mobile Device module.
-This sample app demonstrates the Device Resolver capabilities of the Spring Mobile Device module.
-## Build and Run the Sample Application
+## Build and Deploy
1. Build the app:
@@ -18,6 +17,16 @@ This sample app demonstrates the Device Resolver capabilities of the Spring Mobi
3. Access the project at the following URL:
- http://localhost:8080/lite-device-resolver
+ [http://localhost:8080/lite-device-resolver]
_Note: Accessing this URL from your browser versus an Android emulator or iOS simulator will demonstrate the functionality_
+
+
+## License
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+
+[http://localhost:8080/lite-device-resolver]: http://localhost:8080/lite-device-resolver
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
View
19 lite-showcase/README.md
@@ -1,14 +1,12 @@
-# Spring Mobile Lite Showcase
+# lite-showcase
-## Overview
-
-This sample app demonstrates many of the capabilities of the Spring Mobile Device module, including:
+A [Spring Mobile] sample app demonstrating many of the capabilities of the Spring Mobile Device module, including:
* "Lite" device resolution through the use of DeviceResolverHandlerInterceptor
* Site preference management
* Site switching configured for the URL Path strategy
-## Build and Run the Sample Application
+## Build and Deploy
1. Build the app:
@@ -22,6 +20,15 @@ This sample app demonstrates many of the capabilities of the Spring Mobile Devic
3. Access the project at the following URL:
- http://localhost:8080/lite-showcase
+ [http://localhost:8080/lite-showcase]
_Note: Accessing this URL from your browser versus an Android emulator or iOS simulator will demonstrate the functionality_
+
+
+## License
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+[http://localhost:8080/lite-showcase]: http://localhost:8080/lite-showcase
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
View
19 lite-site-preference-handler/README.md
@@ -1,10 +1,9 @@
-# Spring Mobile Lite Site Preference Handler
+# lite-site-preference-handler
-## Overview
+A [Spring Mobile] sample app demonstrating the Site Preference capabilities of the Spring Mobile Device module.
-This sample app demonstrates the Site Preference capabilities of the Spring Mobile Device module.
-## Build and Run the Sample Application
+## Build and Deploy
1. Build the app:
@@ -18,4 +17,14 @@ This sample app demonstrates the Site Preference capabilities of the Spring Mobi
3. Access the project at the following URL:
- http://localhost:8080/lite-site-preference-handler
+ [http://localhost:8080/lite-site-preference-handler]
+
+
+## License
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+
+[http://localhost:8080/lite-site-preference-handler]: http://localhost:8080/lite-site-preference-handler
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
View
19 lite-site-switcher-handler/README.md
@@ -1,10 +1,9 @@
-# Spring Mobile Lite Site Switcher Handler
+# lite-site-switcher-handler
-## Overview
+A [Spring Mobile] sample app demonstrating many of the Site Switcher capabilities of the Spring Mobile Device module.
-This sample app demonstrates many of the Site Switcher capabilities of the Spring Mobile Device module.
-## Build and Run the Sample Application
+## Build and Deploy
1. Build the app:
@@ -18,6 +17,16 @@ This sample app demonstrates many of the Site Switcher capabilities of the Sprin
3. Access the project at the following URL:
- http://localhost:8080/lite-site-switcher-handler
+ [http://localhost:8080/lite-site-switcher-handler]
_Note: Accessing this URL from your browser versus an Android emulator or iOS simulator will demonstrate the functionality_
+
+
+## License
+
+[Spring Mobile] is released under version 2.0 of the [Apache License].
+
+
+[http://localhost:8080/lite-site-switcher-handler]: http://localhost:8080/lite-site-switcher-handler
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
View
81 thorax-lumbar-client/README.md
@@ -1,57 +1,62 @@
-thorax-lumbar-client
-====================
-This sample demonstrates the use of Spring Mobile to direct requests coming from a variety of devices
-to device-specific content that is created as the result of building a Thorax project with Lumbar.
+# thorax-lumbar-client
-From the description on its website (http://walmartlabs.github.com/lumbar/), Lumbar is a js-build tool
-that takes a general codebase and list of platforms to generate modular platform specific applications.
-What that means is that Lumbar pulls together commons HTML, JavaScript, CSS, and other resources along
-with resources that are specific to distinct platforms and creates an individual platform-specific
-application for each platform defined in its build file (lumbar.json).
+A [Spring Mobile] sample app demonstrating the use of Spring Mobile to direct requests coming from a variety of devices to device-specific content that is created as the result of building a Thorax project with Lumbar.
-Thorax (http://walmartlabs.github.com/thorax/) is another project from WalmartLabs that extends the
-popular Backbone JavaScript framework to be more opinionated and offer more features.
-Spring Mobile is well-suited for directing requests to platform-specific URLs and Lumbar is well-
-suited for created platform-spefific application websites. This seems like a natural match and is what
-is demonstrated in this sample.
+## Overview
-Build Instructions
-------------------
-In order to build this application, you must have Lumbar installed. You do not need to install Thorax
-unless you intend to use the Thorax command-line tool to further extend the sample.
+From the description on its website, [Lumbar] is a js-build tool that takes a general codebase and list of platforms to generate modular platform specific applications. What that means is that Lumbar pulls together commons HTML, JavaScript, CSS, and other resources along with resources that are specific to distinct platforms and creates an individual platform-specific application for each platform defined in its build file (lumbar.json).
-To install Lumbar use the node package manager:
+[Thorax] is another project from [WalmartLabs] that extends the popular [Backbone] JavaScript framework to be more opinionated and offer more features.
- npm install -g lumbar
+[Spring Mobile] is well-suited for directing requests to platform-specific URLs and Lumbar is well-suited for created platform-specific application web sites. This seems like a natural match and is what is demonstrated in this sample.
+
+
+##Build and Deploy
+
+In order to build this application, you must have Lumbar installed. You do not need to install Thorax unless you intend to use the Thorax command-line tool to further extend the sample.
+
+1. Install Lumbar using the node package manager:
+
+ $ npm install -g lumbar
-Or, to install Thorax along with Lumbar:
+ Or, install Thorax along with Lumbar:
- npm install -g lumbar thorax
+ $ npm install -g lumbar thorax
-Although you can run the "lumbar" command at the command line to build only the Thorax portion of
-the application, we've added tasks to the Gradle build to incorporate the Lumbar build into the Spring
-Mobile project. To run *only* the Lumbar portion of the build:
+2. Although you can run the "lumbar" command at the command line to build only the Thorax portion of the application, we've added tasks to the [Gradle] build to incorporate the Lumbar build into the Spring Mobile project. To run *only* the Lumbar portion of the build:
- gradlew lumbar
+ $ ./gradlew lumbar
-Or, to create a WAR file that includes the Spring MVC/Mobile application and the Lumbar-built
-platform-specific artifacts:
+ Alternatively, you may create a WAR file that includes the Spring MVC/Mobile application and the Lumbar-built platform-specific artifacts:
- gradlew build
+ $ ./gradlew build
-The build task will run the lumbar task prior to packaging the application in a WAR file.
+ _Note: The build task will run the lumbar task prior to packaging the application in a WAR file._
+
+3. Deploy and run the application in Tomcat using the Tomcat Gradle plugin:
+
+ $ ./gradlew tomcatRunWar
+
+4. Access the project at the following URL:
+
+ [http://localhost:8080/thorax-client]
+
+ Depending on whether your browser is a normal, mobile, or tablet client, you will be redirected to the platform-specific version of the application.
-You may also run the application in Tomcat using the Tomcat Gradle pluing:
+ _Note: it is important that you run Gradle with the tomcatRunWar task and not the tomcatRun task. The tomcatRunWar task will ensure that the Lumbar build has taken place and will include the Lumbar-built artifacts in the running application._
- gradlew tomcatRunWar
-Then point your browser at http://localhost:8080/thorax-client
+## License
-Depending on whether your browser is a regular, tablet, or mobile client, you'll be redirected
-to the platform-specific version of the application.
+[Spring Mobile] is released under version 2.0 of the [Apache License].
-Note that it is important that you run Gradle with the tomcatRunWar task and not the tomcatRun
-task. The tomcatRunWar task will ensure that the Lumbar build has taken place and will include the
-Lumbar-built artifacts in the running application.
+[Spring Mobile]: http://www.springsource.org/spring-mobile
+[Lumbar]: http://walmartlabs.github.com/lumbar/
+[Thorax]: http://walmartlabs.github.com/thorax/
+[WalmartLabs]: http://www.walmartlabs.com/
+[Backbone]: http://backbonejs.org/
+[Gradle]: http://www.gradle.org/
+[http://localhost:8080/thorax-client]: http://localhost:8080/thorax-client
+[Apache License]: http://www.apache.org/licenses/LICENSE-2.0
Please sign in to comment.
Something went wrong with that request. Please try again.