From 6bac32e2d31b2aa669e1811ec91ea939037a5712 Mon Sep 17 00:00:00 2001 From: Juri Di Rocco Date: Sat, 10 Jun 2023 10:38:05 +0200 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f58d6ea..234711d 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,23 @@ deployment and querying of the modelled data models are supported. - TyphonML supporting tools detect inconsistent data models (e.g. data entities in relational databases that refer to inexistent collections in document-based data models). - TyphonML supporting tools provide modellers with early feedback about the specified data models (i.e. deployment feasibility of the modelled data with respect to the actual resource availabilities). - + ## How to install TyphonML +To better support reproducibility, we now provide also a updatesite at http://rasta.gssi.it/tml/repository to permit the Eclipse installation as best practices suggest. ### Build TyphonML locally -Clone this repository and build the update site with `mvn clean package`. -It is worth nothing that the project project reaquires Java 1.8. Please, run maven comment with Java 1.8 version. - -Once the system has been build, you find the update site ready to be imported by Eclipse in the following folder `it.univaq.disim.typhonml.parent/releng/it.univaq.disim.typhonml.update/target`. +Clone this repository and build the update site with `mvn clean package`. +It is worth nothing that the project project reaquires Java 1.8. Please, run maven comment with Java 1.8 version. + +Once the system has been build, you find the update site ready to be imported by Eclipse in the following folder `it.univaq.disim.typhonml.parent/releng/it.univaq.disim.typhonml.update/target`. Finally, install the Eclipse plugin by _Eclipse -> Help -> Install New Software... -> Add... -> Archive... -> path of folder, i.e., it.univaq.disim.typhonml.parent/releng/it.univaq.disim.typhonml.update/target ### How to install Typhon plugins +[UPDATE SITE] http://rasta.gssi.it/tml/repository + The next step is to install all the plugins required to start Typhon Development, through the Install New Software option: ![installation - step 1](documentation/images/install-01.png "title") @@ -216,7 +219,7 @@ Previously, we described how to open a TyphonML models by the graphical editor. ## Generation of the OpenAPI specification In this section, we describe how the OpenAPI specification is generated from the TyphonML model. In particular, it is a specification for describing, consuming, and visualizing RESTful web services which allows both humans and machines to discover and understand the provided services. An OpenAPI definition can be used for many purposes, e.g., documentation, generation of clients in various programming languages, displaying APIs as a web UI, testing, and many other use cases. Once the TyphonML specification is completed, a synthesis tool is applied to generate the corresponding OpenAPI specification by a set of coordinated Acceleo-based model-to-code transformations . -The contextual menu (see the next figure) allows the modeler to produce the OpenAPI specification of a given TyphonML model. Then, she can use it to directly generate clients in various programming languages that programmatically interact with the polystore resources. +The contextual menu (see the next figure) allows the modeler to produce the OpenAPI specification of a given TyphonML model. Then, she can use it to directly generate clients in various programming languages that programmatically interact with the polystore resources. ![usage - step 03](documentation/images/generation-01.png)