Commit 6d256628 authored by Jerome Royan's avatar Jerome Royan
Browse files

update the readme

parent 688b90a6

README.md

+7 −8
Original line number Diff line number Diff line 
*This repository is part of the outcomes of the Specialist Task Force 620 and 669 focusing on the authoring and use of a World Representation as part of the ETSI ISG Augmented Reality Framework architecture (https://www.etsi.org/deliver/etsi_gs/ARF/001_099/003/01.01.01_60/gs_ARF003v010101p.pdf).*

*The set of the World Representation components includes:*



*•	The C++ and C# source code for servers and clients  generated from OpenAPI available here (https://forge.etsi.org/rep/arf/arf005)*

*•	The C, C++ and C# source code for servers and clients  generated from OpenAPI available here (https://forge.etsi.org/rep/arf/arf005)*



*•	A Unity plugin and a Unity editor for authoring and accessing a World Representation hosted on a World Storage server.*
@@ -11,19 +11,18 @@ 


---



# WORLD STORAGE CPP SERVER (RestBed)

# WORLD STORAGE C CLIENT (LibCurl)



## Description



This repo contains a restbed server library generation pipeline compliant to the World Storage API.

It also contains a sample using that library, it's a basic implementation allowing the user to perform all CRUD operations on the Trackable models.

This repo contains a libCurl client library generation pipeline compliant to the World Storage API.



## Repo Content



|   |  File / Folder |                                                                                    Description                                                                                    |

|:-:|:--------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

| 📂 | EtsiServerGen  | The folder where the library code will be generated, the openapi generator is set to not overwrite the CmakeLists.txt used to generate and export the library to the user's sytem |

| 📂 | EtsiServerImpl | This folder contains a basic implementation of this library, its main set up a local hosted server on port 8080 waiting for CRUD REST queries on the Trackable objects             |

| 📂 | EtsiClientGen  | The folder where the library code will be generated, the openapi generator is set to not overwrite the CmakeLists.txt used to generate and export the library to the user's sytem |

          |

| 📂 | arf005         | A submodule pointing to the git containing the API specification file                                                                                                             |

| 📃 | package.json   | The file containing the npm scripts automating the whole library generation process                                                                                               |
@@ -64,8 +63,8 @@ To generate the code and the DLLs use the following commands: 


You will find the header files in:

    

    /usr/local/include/worldStorageRestBedcppServer/

    /usr/local/include/worldStorageCClient/



and the library file in:

    

    /usr/local/lib/libworldStorageRestBedcppServer.so
 
    /usr/local/lib/libworldStorageCClient.a