You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2014/03/24 18:21:02 UTC
[14/26] git commit: Update README.md
Update README.md
Moving docs to the website.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/3ccd913b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/3ccd913b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/3ccd913b
Branch: refs/pull/76/head
Commit: 3ccd913b692bea8902ee40e18d6d03c94318e60d
Parents: 3f93ca7
Author: Dave Johnson <da...@rollerweblogger.org>
Authored: Sun Mar 23 18:03:51 2014 -0400
Committer: Dave Johnson <da...@rollerweblogger.org>
Committed: Sun Mar 23 18:03:51 2014 -0400
----------------------------------------------------------------------
README.md | 62 ----------------------------------------------------------
1 file changed, 62 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/3ccd913b/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index faaf832..533f593 100644
--- a/README.md
+++ b/README.md
@@ -10,66 +10,4 @@ This repository contains all the code for Apache Usergrid, including the server
* the admin portal and the many SDKs. A pure HTML5+JavaScript app allowing you to register developers and let them manage their apps in a multi-tenant cluster. Located under [`/portal`](portal)
* SDKs for [iOS](sdks/ios), [Android](sdks/android), [HTML5/JavaScript](sdks/html5-javascript), [node.js](sdks/nodejs), [Ruby on Rails](ruby-on-rails), [pure Ruby](sdks/ruby), [PHP](sdks/php), (server-side) [Java](sdks/java) and [.Net / Windows](sdks/dotnet), located in their respective subdirectories under [`/sdks`](sdks).
-How to build and run Usergrid locally
--------------------------------------
-It's easy to build and run Usergrid locally. All you need is the Java JDK 1.7 and Maven 3.0.5 installed and on your path. Here's how you do it. First you get the source code like this:
-
- git clone git@github.com:usergrid/usergrid.git
-
-Next, you change directories into the Java SDK package and build the SDK:
-
- cd usergrid/sdks/java
- mvn clean install
-
-Next, you change directory into the stack directory and build the Usergrid WAR and launcher:
-
- cd ../..
- cd stack
- mvn clean install
-
-Finally, you can run Usergrid locally by using the all-in-one launcher, which includes a web server (Grizzly) and the database (Cassandra):
-
- cd launcher
- java -jar target/usergrid-launcher-0.0.29-SNAPSHOT.jar
-
-(you might have to substitute 0.0.29-SNAPSHOT with something newer)
-
-You should see the Usergrid launcher UI and from there you can start Usergrid and access the admin console.
-
-If not, subscribe to the [user mailing list](mailto:user-subscribe@usergrid.incubator.apache.org) and we can help you out.
-
-
-Backwards compatibility
------------------------
-
-If you previously developed with Apache Usergrid, you know our code used to be structured into _separate_ repositories: usergrid-stack, usergrid-portal, etc. We are now using a _merged_ repository.
-
-### How to update your code setup & pull changes from your old forks
-
-You just need to clone this repository, and use [git subtree (usually requires git 1.8+)](http://engineeredweb.com/blog/how-to-install-git-subtree/) to merge your changes under the new structure. Here’s an example for a portal fork. Adjust the prefix, repository address and branch you want to pull from as necessary.
-
- git clone git@github.com:usergrid/usergrid.git
- cd usergrid
- git subtree pull --prefix=portal git@github.com:my-github-account/my-usergrid-portal-fork.git master
-
-This will pull (i.e. merge) the changes you made from the master branch of github.com/my-github-account/my-usergrid-portal-fork into the portal/ subfolder. It should ask you to provide a commit message for the merge. There’s lot of flexibility on how to fetch and merge, [please see the git subtree manual](https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt) for details. Then please do consider sending us a pull request with these changes ;)
-
-
-### How to pull commits made on this repo into your old forks
-
-You should really update your old repositories to the new structure with the instructions above, but the following may work for you, although we make no guarantee they will work in the future.
-
-You can produce a branch compatible with the old repos by using [git subtree (usually requires git 1.8+)](http://engineeredweb.com/blog/how-to-install-git-subtree/). Then from this repository you can
-
- git clone git@github.com:usergrid/usergrid.git
- cd usergrid
- git checkout master
- git subtree split --prefix=portal -b portal
- git checkout portal
-
-This will create a “portal” branch that is compatible with the old usergrid-portal repository, from the code under the portal/ directory. You can pull from that branch (or push changes to it, although we will not accept pull requests sent thusly).
-
-The `git subtree split` above should function for portal, ugc, and any of the SDKs, but will not work for the stack, due to some anonymous comments left in the tree that prevent a split, and cannot be corrected lest we break the history and force a rebase on all forks.
-
-**Please update your code setup as soon as possible and [ask the dev list](https://mail-archives.apache.org/mod_mbox/incubator-usergrid-dev/) if you have any questions!**