Commit 64edd9a2 authored by Yann Garcia's avatar Yann Garcia
Browse files

Review README.md file

parent e58c3e35

README.md

+22 −16
Original line number Diff line number Diff line
@@ -37,15 +37,16 @@ The following STFs were or are currently involved in the evolutions of the ETSI 
The ETSI ITS protocols project builds and tests regularly on the following platforms:



  - Linux (Ubuntu)

  - Windows (cygwin, npcap and OpenSSL-Win64 are required)

  - Windows ([Cygwin x64](https://cygwin.com/install.html), [Npcap SDK x64](https://nmap.org/npcap/#download) and [OpenSSL-Windows x64](https://www.openssl.org) are required)



Note: The [OpenSSL](https://www.openssl.org) version >= 1.1.1 is also required.



### How to do it?



They are two different methods:

They are three different methods:

- Using [Vagrant](https://www.vagrantup.com/)

- Using [Docker](https://www.docker.com/)

- Using [Eclipse TITAN on Windows or Linux](https://projects.eclipse.org/projects/tools.titan/downloads)



How to choose one of these methods is depending of your host system.
@@ -62,7 +63,7 @@ Vagrant requires a virtual machine. You can use either VirtualBox or WMware. 
Docker does not need a virtual machine, so it is the more efficant way.





### Using Vagrant

#### Using Vagrant



Pre-requisites on your host machine:

- Install [Virtualbox](https://www.virtualbox.org/manual/ch01.html)
@@ -140,7 +141,7 @@ $ ./docker/run-container.sh 
- Switch to the next clause (Usage)





### From scratch

#### From scratch



Pre-requisites:

- Install Virtualbox
@@ -214,6 +215,19 @@ $ git clone 
- Switch to the next clause (Usage)





#### Using Eclipse TITAN



When cloning the ETSI ITS project, you can find two specific files:

- TTF0002.tpd

- TTF0002_Linux.tpd



These two files are used create the ETSI ITS project workspace on Eclipse TITAN. To do it, please follow the steps below:

- Start eclipse using a new workspace, (e.g. with the name workspace_titan)

- Select the menu option File/import

- In the Dialog box,select TITAN/Project from .tpd file

- Select the correct TTF0002 .tpd file and follow the instructions





## Usage



This clause describes how to compile and execute an Abstract Test Suite.
@@ -224,18 +238,10 @@ Pre-requisites: 
- Your machine is installed following one of the installation method describes in the previous clause

- Refer to the ETSI TS 103 099 for the description of the Test System architecture and configuration

- Your are logged as 'etsi' or 'vagrant' user



Procedure using Eclipse TITAN:

- Start eclipse using a new workspace, (e.g. with the name workspace_titan)

- Download and follow the steps to install Eclipse plugins for TITAN, accessible [here]{https://www.eclipse.org/downloads/download.php?file=/titan/Eclipse_installationguide.pdf}

- Open the workspace_titan

- Create a new TITAN project importing TTF0002.tpd file (e.g. TTF0002_Its)

<TODO>



Procedure in TITAN command line:

- Procedure using TITAN command line (only):

    - Open several SSH session (PuTTY...)

    - Change to the directory ~/dev/TTF0002_Its/src/AtsCAM/objs

- Build the test suite AtsCAM

    - Build the test suite AtsCAM using the following command:



```sh

$ ../bin/cam_generate_makefile.bash