summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Kocoloski <adam@cloudant.com>2010-08-24 15:00:34 -0400
committerAdam Kocoloski <adam@cloudant.com>2010-08-24 15:00:40 -0400
commit9c7ed4d934eb41324bf8b2aaf62a5469fccc9fdc (patch)
tree7bfd8bf1f785d8ab74b2f495f48a038ed1543011
parent3b92c5db821d1f52ec916cf48b4f6f38a30296a7 (diff)
update README and remove redundant INSTALL instructions
-rw-r--r--INSTALL.md33
-rw-r--r--README.md6
2 files changed, 3 insertions, 36 deletions
diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index ac60f41a..00000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,33 +0,0 @@
-1. Getting Started
-
-Cloudant-core uses a rebar-based build system. Custom build paths and the like
-are available using templates. If you want to customize those templates, run
-the `bootstrap` command to install the defaults into ~/.rebar and go from there.
-This step is optional.
-
-2. Dependencies
-
- * Erlang R13B03 or higher
- * ICU (4.2 is preferable)
- * Spidermonkey (1.9.2 preferable, [https://launchpad.net/~commonjs/+archive/ppa/][6]) and symlink /usr/lib/libmozjs-1.9.2.so to /usr/lib/libmozjs.so to make things easier
- * OpenSSL
- * make
-
-On OS X the Erlang and ICU dependencies are easily satisfied by Homebrew:
-
- brew install erlang icu4c
- brew ln icu4c
-
-Once the dependencies are installed you can use `make` to build the code,
-`make check` to run unit tests, and `make clean` to reset.
-
-3. Release Generation
-
-The `make dist` command will build a standard release in `rel/dbcore`. The
-release includes a start script at `rel/dbcore/bin/dbcore`
-
-4. Caveats
-
-The build system really really wants the couch .ini files to be in
-`/opt/dbcore/etc`, and the data files to be in `/srv`. It wouldn't be too
-difficult to template this. But for now, the recommended installation is to move the rel/dbcore folder to /opt/
diff --git a/README.md b/README.md
index 020dabf8..5e59004e 100644
--- a/README.md
+++ b/README.md
@@ -44,16 +44,16 @@ To install Spidermonkey 1.9.2 from PPA:
#### Building and installing dbcore
-`$CLOUDANT_SRC` is the directory holding your downloaded source files, while `$CLOUDANT_PREFIX` is the prefix to which the software is installed (defaults to `/opt`):
+`$CLOUDANT_SRC` is the directory holding your downloaded source files, while `$PREFIX` is the prefix to which the software is installed (defaults to `/opt/dbcore`):
cd $CLOUDANT_SRC
- ./configure -p $CLOUDANT_PREFIX
+ ./configure -p $PREFIX
make
sudo make install
#### Starting dbcore
- $CLOUDANT_PREFIX/dbcore/bin/dbcore
+ $PREFIX/bin/dbcore
Now, visit http://localhost:5984/_utils in a browser to verify the CouchDB node is operational.