== Directory structure

jPOS uses http://www.gradle.org/[Gradle] with a *multi-module* setup.

The modules are defined in the `settings.gradle` file and listed below:

* **jpos** : this is the jPOS system
* **compat_1_5_2** : compatibility with older versions

You'll find the jPOS sources in the `jpos/src` directory.

-----------------------------------------------------------------------------
|-- COPYRIGHT                                                             <1>
|-- CREDITS
|-- LICENSE
|-- README.md                                                             <2>
|-- build.gradle                                                          <3>
|-- settings.gradle                                                       <4>
...
...

|-- gradlew                                                               <5>
|-- gradlew.bat
|-- gradle                                                                
|   `-- wrapper
|       |-- gradle-wrapper.jar
|       `-- gradle-wrapper.properties
...
...
|-- jpos                                                                  <6>
|   |-- build.gradle
|   |-- src
|   |   |-- main
|   |   |   |-- java
|   |   |-- main
|   |   |   |-- resources
|   |   |-- dist                                                          <7>
|   |   |   |-- bin
|   |   |   |   |-- bsh
|   |   |   |   |-- q2
|   |   |   |   |-- start
|   |   |   |   `-- stop
|   |   |   |-- cfg
|   |   |   |   |-- packager
|   |   |   |   |   |-- base1.xml
|   |   |   |   |   |-- base24-eps.xml
|   |   |   |   |   |-- base24.xml
...
...
|   |   |   |-- deploy
|   |   |   |   |-- 00_logger.xml
|   |   |   |   `-- 99_sysmon.xml
|   |   |   `-- log
|   |   |       `-- q2.log
...
...
-----------------------------------------------------------------------------
<1> Copyright notice
<2> Readme file in markdown format shown in the https://github.com/jpos/jPOS[Github] repository
<3> Main Gradle configuration file
<4> Gradle's `settings` file, lists the modules to be compiled, in this case, `jpos` and `compat_1_5_2`.
<5> It is recommended that you install Gradle locally, but for a quick build, you can use the Gradle wrapper (`gradlew` in Unix, `gradlew.bat` in Windows).
<6> Home for the jPOS module
<7> Template for a production distribution directory with its deploy, cfg, bin and log directories

-----------------------------------------------------------------------------
|-- compat_1_5_2                                                          <1>
|   |-- build.gradle
|   |-- compat_1_5_2.iml
|   |-- src
|   |   `-- main
|   |       `-- java
|   |           `-- org
|   |               `-- jpos
|   |   |   `-- resources
...
...
|-- legal                                                                 <2>
|   |-- cla-template.txt
|   |-- ccla-template.txt
|-- incoming                                                              <3>
...
...
-----------------------------------------------------------------------------
<1> Backward compatibility with version 1.5.2
<2> Legal directory with contributor license agreements
<3> Contributed files not yet merged into jPOS. Now with Git and pull requests, this directory will be removed at some point.

[TIP]
=====
Unless you're dealing with a legacy jPOS system, you probably don't want to use
the `compat_1_5_2` module.  
=====

