From a745167c75bf8ba599ffbb53132e892a18973e2c Mon Sep 17 00:00:00 2001 From: Paulo Gustavo Veiga Date: Sat, 25 Jan 2014 15:43:46 -0300 Subject: [PATCH] Minor fix on documentation. --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3e9ce963..0b6eff4f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -## Project Information +# Project Information The goal of this project is to provide a high quality product that can be deployed by educational and academic institutions, private and public companies and anyone who needs to have a mindmapping application. WiseMapping is based on the same code source supporting WiseMapping.com. More info: www.wisemapping.org -# Compiling and Running +## Compiling and Running -## Prerequisites +### Prerequisites The following products must be installed: * Java Development Kit 7 or higher ([http://www.oracle.com/technetwork/java/javase/downloads/index.html]) * Maven 3.x or higher ([http://maven.apache.org/]) -## Compiling +### Compiling WiseMapping uses Maven as packaging and project management. It's composed of 5 maven sub-modules: @@ -27,7 +27,7 @@ The full compilation of the project can be performed executing within /wise-webapp/target/wisemapping*.war will be generated. -## Testing +### Testing The previously generated war can be deployed locally executing within the directory /wise-webapp the following command: `cd wise-webapp;mvn jetty:run-war` @@ -37,17 +37,31 @@ This will start the application on the URL: [http://localhost:8080/wise-webapp/] User: test@wisemapping.org Password: test +## Running the JS only version + +Start by creating the .zip file: + +`mvn assembly:assembly -Dmaven.test.skip=true` + +To test the javascript frontend you then do: + + ruby -rwebrick -e 'WEBrick::HTTPServer.new(:Port=>8000,:DocumentRoot=>".").start' + +Now open a browser using the URL http://localhost:8000/wise-editor/src/main/webapp/ + ## Members -Founders +### Founders * Pablo Luna * Paulo Veiga -Individual Controbutors +### Individual Controbutors + * Ezequiel Bergamaschi -Past Individual Contributors +### Past Individual Contributors + * Ignacio Manzano * Nicolas Damonte