Permalink
Browse files

cleaning up docs

  • Loading branch information...
1 parent 5a8edc8 commit 8077c9086567186998e1e2fa2bcaa1b94373e7e7 @progrium progrium committed Jan 18, 2011
Showing with 6 additions and 8 deletions.
  1. +6 −8 README.md
View
@@ -1,16 +1,14 @@
# Shared Resources
-This is a collection of shared modules and resources for other Dojo applications. It should be included
-as a submodule to all Dojo app repositories. It's recommended to keep it pointed to the public canonical
-Hacker Dojo repo as a directory called "shared" at the root of your project directory. Like so:
+This is a collection of shared modules and resources for Hacker Dojo applications. It should be included as a submodule to all Dojo app repositories.
- git submodule add git://github.com/hackerdojo/hd-shared.git shared
+## Including in a new Dojo app repo
+
+It's recommended to point to the public canonical hd-shared repo as a directory called "shared" at the root of your Dojo app project directory. Here is the command to set it up:
-which will give you a .submodule file that looks like this:
+ git submodule add git://github.com/hackerdojo/hd-shared.git shared
- [submodule "shared"]
- path = shared
- url = git://github.com/hackerdojo/hd-shared.git
+Now you will have access to these shared resources in your Dojo project under the "shared" directory.
## Running Tests

0 comments on commit 8077c90

Please sign in to comment.