====

	Copyright (C) 2010 Red Hat, Inc. All rights reserved

    This is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2.1 of
    the License, or (at your option) any later version.

    This software is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this software; if not, write to the Free
    Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
    02110-1301 USA, or see the FSF site: http://www.fsf.org.

====

====
Authors :
   * Nabil Benothman <[email protected]>
   * Anne Leticia MIKIELA <[email protected]>
====


Welcome on GateIn Analytic Portal

This project tends to provide an analytic portal based on Google Analytics,
and is a maven project. This project was built using Java 6 but compatible
Java 5. To install, deploy and run the project please follow steps below :


1) If you don't have maven installed yet, so start with downloading and install
   it, you find all steps for that in the link below, to ensure that it was 
   correctly installed, open a terminal window and type the following command :
   
   ~home$ mvn --version
   
   and you should have something like this (run on Mac OSX) :
   
	Apache Maven 3.0.3 (r1075438; 2011-02-28 18:31:09+0100)
	Maven home: /usr/share/maven
	Java version: 1.6.0_29, vendor: Apple Inc.
	Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
	Default locale: en_US, platform encoding: UTF-8
	OS name: "mac os x", version: "10.7.3", arch: "amd64", family: "mac"
   
   
   NB : if you are using Windows OS, please refer to Maven website for more
        details about how to install and configure Maven.
   
   Download link : http://maven.apache.org/

2) Once installed and configured, open a terminal window and go to the project
   install directory. Type the command below :
   
   	~projectHome$ mvn clean install
   
   this should take a while until maven resolve all dependencies and downloads
   needed libraries, note that this is only for the first build because maven
   install libs locally.

3) Once built, you should have a war file under directory "target" that you
   can deploy on your GateIn portal server.
   
4) To register the portlet, please refer to GateIn tutorial. Note that it is
   recommended to add the portlet to application layout and not to a specific
   page, otherwise only that page will be tracked.
   
5) After registering and adding the portlet, you should have a valid Google
   Analytics account where you can register you domain to get a Track ID that
   you will use for tracking your application.
   
6) Once you have all the ingredients, logon as administrator and open the portlet
   in edit mode, enter your track ID, select your options and click on save button.
   
7) Now it is ready to work !