[DE] update rteadme and .gitignore

.gitignore

@@ -1,3 +1,4 @@
 out/
+target/
 *.class
 .settings/

README.md

@@ -1,18 +1,60 @@
-Generic backend for archidata in java
+Archi-data
-===================================
+==========
 
+Archi-data is a framework that simplify:
+  - Creating a REST server with:
+    - Right control
+    - Swagger display interface
+    - Normalize error generate by the server
+  - Access to the DB:
+     - introspect Object and insert in the TD (SQLITE & MY-SQL)
+     - Manage migration
+  - JPA checker for many generic request
+  - simplify the request of the Test-service
+  
+  
+Develop in cmd-line:
+--------------------
 
+The first step is configuring your JAVA version (or select the JVM with the OS)
 
+```bash
+export PATH=$(ls -d --color=never /usr/lib/jvm/java-2*-openjdk)/bin:$PATH
+```
 
+Install the dependency:
+
+```bash
 mvn install
+```
 
-// create a single package jar
+Run the test
-mvn clean compile assembly:single
+```bash
+mvn test
+```
 
+Install it for external use
+```bash
+mvn install
+```
 
+Develop With Eclipse:
+--------------------
 
-generic interface for all KAR web application
+Import the project:
+  - Open a (new) project on eclipse
+  - `File` -> `Import`
+    - `Maven` -> `Existing Maven project`
+    - Select the `pom.xml` file and click on import
 
+Run the Test:
+  - Open the package `test.kar.archidata`
+  - Click right on it
+  - Select `Debug As` -> `JUnit Test`
+
+Install in the local maven repository:
+  - Click right on the `pom.xml` file
+  - Select `Run As` -> `Maven install`
 
 
 Somes tools:
@@ -21,7 +63,7 @@ Somes tools:
 Auto-update dependency:
 -----------------------
 
-auto-update to the last version dependency:
+Auto-update to the last version dependency:
 
 ```bash
 mvn versions:use-latest-versions
@@ -36,6 +78,21 @@ Simply run the cmd-line:
 mvn formatter:format
 ```
 
+Reformat XML file like the pom.xml
+
+```bash
+XMLLINT_INDENT="	" xmllint  --format "back/pom.xml" -o "back/pom.xml"
+```
+
+
+Enable the pre-commit checker
+-----------------------------
+
+```bash
+./tools/configure_precommit.bash
+```
+
+> **_Note_**: You can change the code in `.git/hooks/pre-commit` by replacing `formatter:verify` with `formatter:format` to auto format the code @ every commit
 
 Add Gitea in the dependency for the registry:
 =============================================
@@ -65,7 +122,7 @@ edit file: ```~/.m2/settings.xml```
 release:
 ========
 
-```
+```bash
 export PATH=$(ls -d --color=never /usr/lib/jvm/java-2*-openjdk)/bin:$PATH
 mvn install
 mvn deploy

tools/pre-commit

@@ -18,7 +18,7 @@ function __run() #(step, name, cmd)
     if [[ 0 == $exitcode ]]; then
         echo -e "${C_GREEN}OK!${C_RESET}"
     else
-        echo -e "${C_RED}NOK! (${exitcode})${C_RESET}\n\n$output"
+        echo -e "${C_RED}ERROR! (${exitcode})${C_RESET}\n\n$output"
         exit 1
     fi
 }