Skip to content

Commit

Permalink
Added file INSTALL and updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
kamidev committed Dec 6, 2009
1 parent 348a810 commit 7d7f98e
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
32 changes: 32 additions & 0 deletions INSTALL
@@ -0,0 +1,32 @@
The easiest way to test DroidCouch is to create a new Eclipse project and run the test client

If you don't already have Eclipse and the latest Android SDK, please install them.
See http://developer.android.com/sdk/installing.html for details.

You also need a CouchDB server that you can access via HTTP. It can be either remote or local.
See http://couchdb.apache.org/ for details on how to install CouchDB.

Installation:

1. Use menu alternative File -> New project -> Other -> Android project -> Specify from existing source.
2. Browse to the directory you checked out from GitHub and select it.
3. Use default values for everything

Note: if you intend to run on a real phone, please specify a compatible SDK version.
Currently we default to SDK 1.5, which works for most phones currently on the market.

4. Change the file TestClient.java

Find the line: //String HOST = "ADD_YOUR_OWN_COUCHDB_SERVER_HERE";
and add a valid URL to your own server. Note that the URL should end with a forward slash.

5. Try running the project using "Debug as -> Android project"

If everything works, you will see the test application in the emulator.
After a few seconds, it should then display: All tests passed!

Good luck!




6 changes: 5 additions & 1 deletion README
Expand Up @@ -2,5 +2,9 @@ DroidCouch is a minimal Android library for using CouchDB, licensed under the MI


Our intention is to make a small Java library well suited for Android mobile development. Our intention is to make a small Java library well suited for Android mobile development.


DroidCouch was inpired by Divan (http://github.com/foretagsplatsen/Divan), a C# library with a more or less complete CouchDB API. Initiated by Jonas Beckman, DroidCouch is currently developed in-house at MSC Konsult AB. DroidCouch was inpired by Divan (http://github.com/foretagsplatsen/Divan), a C# library with a more or less complete CouchDB API. DroidCouch is currently developed in-house at MSC Konsult AB.

To get started, read the file INSTALL.




0 comments on commit 7d7f98e

Please sign in to comment.