Permalink
Browse files

Updating README

  • Loading branch information...
1 parent 328fae5 commit 30cc7f50b8d7bd7b8f8fb40a5cc8d2ae5a690a5d @mariano committed Mar 21, 2012
Showing with 44 additions and 6 deletions.
  1. +42 −4 README.md
  2. +1 −1 package.json
  3. +1 −1 wscript
View
@@ -5,17 +5,55 @@ database bindings visit the [Node.js db-mysql homepage] [homepage].
## INSTALL ##
+### OCI libraries ###
+
Before proceeding with installation, you need to have the
-[OCI instant client] [oci] [libraries] [oci-lib] and [include files] [oci-inc].
-In order for the installation script to locate them properly, you'll
-need to set the OCI_INCLUDE_DIR and OCI_LIB_DIR environment variables.
-For example:
+[OCI instant client] [oci] [libraries] [oci-lib] and [include files] [oci-inc].
+For example, you download the `instantclient-basic-linux.x64-11.2.0.3.0.zip`
+library file, and the `instantclient-sdk-linux.x64-11.2.0.3.0.zip` SDK file,
+and save them in your `$HOME/Downloads` directory. You would then uncompress
+both files, and move the generated directory to your `/opt` path:
+
+```bash
+$ cd $HOME/Downloads
+$ unzip instantclient-basic-linux.x64-11.2.0.3.0.zip
+$ unzip instantclient-sdk-linux.x64-11.2.0.3.0.zip
+$ sudo mv instantclient_11_2/ /opt/instantclient
+```
+
+After uncompressing you will probably need to create symbolink links:
+
+```bash
+$ cd /opt/instantclient
+$ sudo ln -s libocci.so.11.1 libocci.so
+$ sudo ln -s libclntsh.so.11.1 libclntsh.so
+```
+
+You will also need `libaio`. In **Arch Linux** this can easily be installed with:
+
+```bash
+$ sudo pacman -S libaio
+```
+
+On **Debian** based distros:
+
+```bash
+$ sudo apt-get install libaio
+```
+
+### Configuring OCI ###
+
+Once you have the library and include files installed, and in order for the
+installation script to locate them properly, you'll need to set the
+`OCI_INCLUDE_DIR` and `OCI_LIB_DIR` environment variables. For example:
```bash
$ export OCI_INCLUDE_DIR=/opt/instantclient/sdk/include/
$ export OCI_LIB_DIR=/opt/instantclient
```
+### Install ###
+
Once the environment variables are set, install with npm:
```bash
View
@@ -2,7 +2,7 @@
, "description" : "Oracle database bindings for Node.JS"
, "keywords": ["database","db","native","binding","library","plugin","client","oracle","oci","occi"]
, "homepage" : "http://nodejsdb.org/db-oracle"
-, "version" : "0.2.2"
+, "version" : "0.2.3"
, "engines" : { "node" : ">=0.4.1" }
, "maintainers" :
[ { "name": "Mariano Iglesias"
View
@@ -11,7 +11,7 @@ from os.path import exists
srcdir = "."
blddir = "build"
-VERSION = "0.2.2"
+VERSION = "0.2.3"
def set_options(opt):
opt.tool_options("compiler_cxx")

0 comments on commit 30cc7f5

Please sign in to comment.