Merge branch 'master' of github.com:bireme/isis-oai-provider

bireme · May 21, 2013 · 69e9099 · 69e9099
2 parents 46050a4 + 87516ea
commit 69e9099
Showing 1 changed file with 4 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -1,108 +1,16 @@
 ISIS-OAI-PROVIDER
 =================
 
-Isis-oai-provider is a software that provides a ISIS databases in OAI protocol to be harvested.
+It is a web application that allows transmission of data stored in CDS-ISIS to be collected by other systems via the communication protocol [OAI-PMH](http://www.openarchives.org/ "Open Archives Initiative").
 
-The application work with PHP 5.3.3 or later.
 
+### Documentation
 
-## Instalation
 
-### Method 1 - Download files
+* [Instalation and configuration](http://wiki.bireme.org/en/index.php/Installing_isis-oai-provider "Instalation and configuration")
+* [About the project ](http://wiki.bireme.org/en/index.php/Isis-oai-provider "About the project")
 
-Download the last version from **Downloads** link from github repository (zip or tar gz file) and
-extract the file to your server.
 
-Example: Creating a structure and extracting application files under server **/opt/** directory:
-
-```
-    $ cd /opt/
-    $ mkdir bireme
-    $ cd bireme
-    $ wget https://github.com/bireme/isis-oai-provider/tarball/master -O isis-oai-provider.tar.gz
-    $ tar xvfzp isis-oai-provider.tar.gz
-    $ mv bireme-isis-oai-provider-53c0abc/ isis-oai-provider
-```
-
-### Method 2 - Clone the project git repository
-
-The advantage of this method is that you can easily update the application later, but it is necessary that the server has the package **git-core** installed.
-
-Example: Creating a structure and download the application repository under server **/opt/** directory:
-
-```
-    $ cd /opt/
-    $ mkdir bireme
-    $ cd bireme
-    $ git clone git://github.com/bireme/isis-oai-provider.git
-```
-
-
-### Deploy the aplication on the Web Server (ex. Apache Web Server)
-
-* Option A - Using a specific VirtualHost for the web application
-
-```
-    <VirtualHost *:80>
-       ServerName isis-oai-provider.local
-       DocumentRoot /opt/bireme/isis-oai-provider/htdocs/
-
-       <Directory "/opt/bireme/isis-oai-provider/cgi-bin">
-            Options +ExecCGI
-            AllowOverride None
-            Order deny,allow
-       </Directory>
-
-       ScriptAlias /cgi-bin/ /opt/bireme/isis-oai-provider/cgi-bin/
-       LogLevel warn
-       CustomLog /var/log/apache2/isis-oai-provider.log combined
-       ServerSignature On
-    </VirtualHost>
-```
-
-* Option B - Using a existing VirtualHost
-
-Assuming you have a website running you need to find the path where is located the following components:
-
-**DocumentRoot**  --- directory where static files and PHP scripts are located
-
-**CGI-BIN**       --- directory with execution permission for CGI scripts
-
-**ISIS dabases**  --- directory on the server where ISIS databases are located
-
-Then move/copy or create symbolic links to the isis-oai-provider directories:
-
-Ex. Assuming a website with this directory structure:
-
-    /home/sites/
-               /site1/
-                     htdocs/
-                     cgi-bin/
-                     bases/
-
-Steps to create symbolic link to the application
-
-    $ cd /home/sites/site1/htdocs
-    $ ln -s /opt/bireme/isis-oai-provider/htdocs/isis-oai-provider/ .
-    $ cd /home/sites/site1/cgi-bin
-    $ ln -s /opt/bireme/isis-oai-provider/cgi-bin/isis-oai-provider/ .
-
-
-### Configuration files
-
-Rename the sample configuration files
-
-```
-    $ cd htdocs/isis-oai-provider/
-    $ mv oai-config-sample.php oai-config.php
-    $ mv oai-databases-sample.php oai-databases.php
-
-```
-### Test
-
-Test the application calling your browser and informing your server name like: **http://your_server_name/isis-oai-provider/**
-
-Ex. http://isis-oai-provider.local/isis-oai-provider/