create a README for the description of the navigation test

2 files changed, 34 insertions, 45 deletions

diff --git a/test/navigation/README b/test/navigation/README
deleted file mode 100644
index b981974..0000000
--- a/test/navigation/README
+++ /dev/null
@@ -1,45 +0,0 @@
-Release date of the file: 19-08-2014 
-Status: to be completed
-
-This folder contains some stuff for testing.
-
------------------------------------
-Python scripts for unitary testing:
------------------------------------
-
-In order to test the navigation core, please do:
-Into a terminal
-cd ../../src/navigation/script
-./run -r 
-NB: Another way to check the state of the process is to run in separate xterms:
-./run -rx
-
-Into another terminal
-cd ../../../test/navigation/
-python test-route-calculation.py
-
-You can see some debug messages into the terminal
-
-To clean up the navigation core, please do:
-kill -9 `ps -ef | grep navit | grep -v grep | awk '{print $2}'`
-
-
-For intensive unitary testing of enhanced position with log replayer
-If you launch it from the formal navigation repos, just do
-python intensive-testing.py
-It will run the test at 5 frames per sec or can be set by parameter (duration 20 sec)
-If you launch it from the navigation-application repos, just do
-python intensive-testing.py -p ../../../../
-
------------------------------------
-Bustle viewer with special patch:
------------------------------------
-
-The bustle code has been patched for Genivi.
-To build it:
-make all2
-
-To run it (for example):
-./run_bustle org.genivi.
-
-
diff --git a/test/navigation/README.md b/test/navigation/README.md
new file mode 100644
index 0000000..405b9f6
--- /dev/null
+++ b/test/navigation/README.md
@@ -0,0 +1,34 @@
+# Test files for Navigation
+## Synopsis
+These folders contain several files that allow to test the navigation.
+Some are for the GlibDBus version:
+test-location-input.py
+test-address-input.py 
+test-map-viewer-control.py
+test-guidance.py
+test-route-calculation.py
+test-all
+and others (*-capi.py) are for the CommonAPI version
+NB: For the time being, only the GlibDBus version of navigation runs well
+##Tested targets
+Desktop: Tested under Ubuntu 16.04 LTS 64 bits
+##How-to test 
+First, open a new terminal and launch the navigation by entering:
+```
+./run -r
+```
+Unitary tests:
+```
+./test-location-input.py -l locations.xml
+./test-route-calculation.py -r routes.xml
+./test-address-input.py -l location.xml
+./test-guidance.py -r route.xml
+./test-map-viewer-control.py
+```
+To launch all the tests:
+```
+./test-all
+```
+NB: The locations and the routes are defined for the map database around Geneva (the reference map database into the repository). 
+
+