Merge pull request #39 from sciodb/develop

docs: Update documentation

README.md

@@ -3,64 +3,40 @@ ScioDB
 
 [![Build Status](https://travis-ci.org/sciodb/sciodb.svg?branch=master)](https://travis-ci.org/sciodb/sciodb)
 
-TODO add description
+
+ScioDB is a NoSQL distributed database prototype, it is designed to scale horizontally to thousands of nodes.
 
 
 What is ScioDB
 ---
-TODO add description
+ScioDB is an open-source distributed database designed to horizontally scale to thousands of nodes. It has a distributed
+architecture using P2P.
 
-Quickstart
----
-TODO add description
 
-Clients
+Quickstart
 ---
-TODO add description
 
-Contributing
----
-# ???
-How to compile:
+At this moment there is no package you can download, if you want to play a bit with the current version you have to
+compile by yourself using maven. It is pretty simple, you just need to clone or download a copy of the current repository
+and execute:
 
 ```
-mvn clean package
+mvn install
 ```
 
-it will compile, package and copy all the libraries in the *lib* folder.
+That will download all the needed libraries, and it will copy the jar files to the lib folder. After that you can start
+Scio DB or multiple Scio DB nodes to play a bit with the system.
 
-How to run the system, you should go to the *bin* folder and execute
-```
-./sciodb.sh
-```
-
-This should start the ScioDB, and you will be able to add or remove nodes to the sciodb.
-For the moment it is only for testing, the system is not functional.
+And then start a single node that will start up a single node from the bin folder:
 
-If you want to see multiple nodes working, you can execute:
-
-```
-./startup.sh {PORT} {SEED}
 ```
-
-For example:
-```
-./startup.sh 9090
-```
-will start a node without seeds. Or if you want to start nodes with a seed to connect:
-
-```
-./startup.sh 9091 0.0.0.0:9090
-```
-
-if you want to stop a node:
-```
-./stop.sh 9090
+./sciodb.sh
 ```
-If you want to learn more about how to start the system, take a look to the [documentation](doc/Readme.md).
+Read [our documentation](./doc/Readme.md) for more details, about how to start up multiple nodes.
 
 Enjoy it!
 
+
 LICENSE
 -------
 

bin/sciodb.sh

@@ -15,7 +15,7 @@ function check_java_version {
         version=$("$_java" -version 2>&1 | awk -F '"' '/version/ {print $2}')
         echo "Current Java version $version"
         if [[ "$version" < "1.8" ]]; then
-            echo "[ERROR] Scio DB requires JDK version 1.8 or later, the current version is $version "
+            echo "[ERROR] ScioDB requires JDK version 1.8 or later, the current version is $version "
             exit 1
         fi
     fi
@@ -31,6 +31,7 @@ done
 
 CLASSPATH=$CLASSPATH:../target/classes/
 
+#java $JAVA_OPTS_SCIODB -cp $CLASSPATH org.sciodb.ScioDB "$@"
 nohup java $JAVA_OPTS_SCIODB -cp $CLASSPATH org.sciodb.ScioDB "$@" > logs/node.log 2>&1 &
 pid=$!
 

doc/Readme.md

@@ -2,24 +2,25 @@ ScioDB Documentation (draft)
 =====
 
 At this moment there is no package you can download, if you want to play a bit with the current version you have to
-compile by yourself using maven. It is pretty simple, you just need to clone or download a copy of the current repository
+compile it by yourself using Maven. It is pretty simple, you just need to clone or download a copy of the current repository
 and execute:
 ```
 mvn install
 ```
-That will download all the needed libraries, and it will copy the jar files to the lib folder. After that you can start
-Scio DB or multiple Scio DB nodes to play a bit with the system.
+That will download all the needed libraries, and it will copy the jar files to the lib folder. After that, you can 
+start ScioDB or multiple Scio DB nodes to play a bit with the system.
 
 How to start a single node
 ---
 
-The normal way to start Scio DB is using the principal script:
+The normal way to start ScioDB is by using the principal script:
 
 ```
-./sciodb.sh
+cd bin
+./sciodb.sh 
 ```
 
-For testing purposive, if you want to start up multiples nodes, you can use the *startup.sh* script. For example:
+For testing purposes, if you want to start up multiple nodes, you can use the *startup.sh* script. For example:
 ```
 ./startup.sh 9090
 ```
@@ -36,4 +37,4 @@ to stop the nodes, you just need to use the port number:
 ./stop.sh 9090
 ```
 
-Copyright (c) 2016 Jesús Navarrete <jesus.navarrete@gmail.org>, released under the GPLv2 license
+Copyright (c) 2016-2023 Jesús Navarrete <jesus.navarrete@gmail.org>, released under the GPLv2 license