===================
gvSIG Educa Batoví
===================
------------------------------------------------------------
gvSIG customization for OLPC laptops of Ceibal project
------------------------------------------------------------
Description
==============
This file is a contents index.
Requirements
==============
* S.O Linux
* Maven 2.6 or higher
* Java JDK 1.5 or higher
For eclipse
-------------
See `developer guide at gvSIG.org `_ and the file ``REAME-ECLIPSE.txt``
Contents
=========
REAME.txt/LEEME.txt
--------------------
This file (in reStructureText format, for more info this format look at `gvSIG portal `_ or at `docUtils reference `_)
docs
---------
Folder with papers related to this project.
org.gvsig.educa.batovi.activity
-----------------------------------
Scripts to generante a *Sugar Activity* contains a gvSIG v2.0 customization.
org.gvsig.educa.batovi.app
-------------------------------
gvSIG Plugins made for Batoví project (UI customization, etc...).
org.gvsig.educa.batovi.mapviewer
-----------------------------------
Little application which allows install and view *Thematic Maps*. Includes *Sugar activity* generator scripts.
Compilation
================
Just for folder which contents code. Other folders has a *README.txt* with all related information.
From shell
------------
Execute this command::
org.gvsig.educa.thematicmap$ mvn clean install
From eclipse
--------------
See `work in a proyect of the developer guide at gvSIG.org `_
In some project, could be better use ``mvn eclipse:clean eclipse:eclipse`` than import project as a *Maven project*. Maven plugin of eclipse does not set classpath correctly in some project.
Packaging
===============
This could be applyed depending every single project:
* *org.gvsig.edica.batovi.activity* is a packager.
* *org.gvsig.educa.batovi.app* contains plugins and its packing process is the very same that gvSIG plugins.
* *org.gvsig.educa.batovi.mapviewer* contains a folder with the packaging process: *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer.activity*
Version
---------------
To changes version number just set in in ``project/version`` tag of *pom.xml* in this folders:
* *org.gvsig.educa.batovi.app*
* *org.gvsig.educa.batovi.mapviewer*
Sub-projects will inherit it.
Version polity is the standard in project. Changes in version number:
* third number: Bug fixes and minors improvements. API must have no changes from previous version.
* second number: Bug fixes and mayor improvements. API can have minor changes. Previously deprecated classes could be removed. No architectural changes.
* first number: Mayor changes.
Create a tag
------------------
TODO: use *maven release* plugin
Use svn copy command to copy version in server. Process could be like this:
#. Check that there ins no changes in workspace::
svn up ; svn status
#. Check that project compiles and passes all test.
mvn clean install
#. Update *pom.xml* to set version of tag (usually removing *-SNAPSHOT*)
#. create tag folder on server::
svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap/tag/{version}
#. Copy current workcopy to tag folder::
svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap/tag/{version}
#. Update *pom.xml* to next version
#. Commit *pom.xml* changes::
svn commit -m "Set new version {version}-SNAPSHOT" pom.xml
i18n
======
The files for internationalization can be found in this folders:
+ *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer/src/main/resources*
The internationalization of this application is based on standard java resource bundle mechanism. So, to add a new language just add the file with the language code to every related folder.