Create initial end-user documentation about how to use the tool

COVESA / franca_ara_tools

Translation between Franca Interface Description Language and AUTOSAR XML interface description language

Eclipse Public License 2.0

43 stars 14 forks source link

Create initial end-user documentation about how to use the tool #18

Open kbirken opened 5 years ago

kbirken commented 5 years ago

Format: Wiki page on this github repository (for now).

Content:

How to run the command-line tool (explain both directions A2F and F2A)
Explain extra validation of Franca files in the IDE (all non-mappable concepts of Franca IDL will be marked if the user tries to use it)
more?

This corresponds to A200.1.

kbirken commented 5 years ago

The documentation will be located in the wiki of this github repository: https://github.com/GENIVI/franca_ara_tools/wiki

TorstenGoerg commented 5 years ago

Explain in the user documentation that all generated Franca model files have an additional file name suffix that matches the package namespace of the Franca model in this file. The namespace suffix is added even if the translation of an AUTOSAR file results in only one Franca file.