A.R.E.A. Files

AREA Augmented Reality Expert Assistant

http://arexpertassistant.es

------------------------------------
LICENSE
------------------------------------
The MIT License (MIT)

Copyright (c) 2013
Josué Candela Perdomo
Juan Francisco Gonzalez Ramos

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
------------------------------------
DESCRIPTION 
------------------------------------
AREA is an expert assistant that allows you to offer to your clients 
or audience information about your brand, localization, event and more,
all in one mobile app.

AREA offers you a complete dashboard on http://arexpertassistant.es
where you can create your entire assistant and once you have completed it 
, extend the code, configure your assistant and compile your finished 
mobile assistant.

The assistant can offer to your audience several types of answers like
GPS, augmented reality (GPS), PDF, sounds, url and images.


------------------------------------
PROJECT
------------------------------------
- assets
	This project uses Phonegap (Cordova) framework, so all the 
	app design, interaction and resources is contained on
	/assets/www as a web application.
	
	-- ARViewer
		Contains files related with the third party plugin ARViewer.
	-- maps-plugin
		Cointains files related with google maps.
	-- js
		Contains all the classes of the project, all the relevant source.
	-- childbrowser
		Contains files related to the third party plugin ChildBrowser.
- bin 
	Contains the binary content generated by Eclipse, your final
	.apk will be here once you have compiled.
- docs
	Contains the "Developer's Guide", useful for your first
	assistant configuration.
- gen
	Contains files auto generated by Android SDK
- libs
	Contains third party libraries:
		- Cordova		
- res
	Contains the layouts, values and resources of the app. 
	It contains the app's icon on drawable-* folders but we
	recommend to read the "Developer's Guide" in order to change
	it.	
- src
	Contains the Java source code, it comprises only the MainActivity
	and third party plugins:
		- LibreSoft, ARViewer
		- ChildBrowser
		- TTS
		- Tsukurusha, ScreenOrientation
		- Urbtek, SpeechRecognizer

------------------------------------
GET THE PROJECT
------------------------------------

You have two choices to download our application:

1- Direct download

	Download the latest version from 
		https://sourceforge.net/projects/ar-ea/files/

2- SVN Checkout
	
	You can have the latest updates using SVN, in order to do that, 
	we recommend you to use the open source software TortoiseSVN. 
        Regardless what SVN software you use, you can download our code
	as follows:

	svn checkout svn://svn.code.sf.net/p/ar-ea/code/trunk ar-ea-code


More information: https://sourceforge.net/p/ar-ea/wiki/F.A.Q./

------------------------------------
TEST THE PROJECT
------------------------------------

For testing purposes we recommend to use our emulator, available on your
dashboard on:
	
	http://arexpertassistant.es

------------------------------------
RUN THE PROJECT (REQUISITES)
------------------------------------

In order to compile the project you should use Eclipse IDE, you will
find its latest version on:
	
	https://sourceforge.net/projects/eclipse.mirror/

If you want to compile your app and run it on an Android device or
emulator, you should install Android SDK Tools and ADT Plugin for 
Eclipse:
	
	http://developer.android.com/sdk/installing/index.html
	http://developer.android.com/sdk/installing/installing-adt.html


------------------------------------
DOCUMENTATION
------------------------------------

You will find more extended documentation on our forge:

https://sourceforge.net/p/ar-ea/wiki/F.A.Q./

The same information will be available on the "Developer's
Guide" placed on the /docs folder.