search

sonia-auv / sonia_common

SONIA's common packages module, include all common classes that could be use around all our modules
GNU General Public License v3.0
0 stars 1 forks source link

readme

sonia_common

SONIA'S custom ROS messages package, containing all custom messages developed to work along with our custom ROS modules

Docker Image CI - Master Branch Docker Image CI - Develop Branch GitHub release (latest by date) Average time to resolve an issue

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Clone current project by using following command :

    git clone git@github.com:sonia-auv/sonia_common.git

Prerequisites

First and foremost to run the module you will need to have docker installed.

To validate your installation of docker, simply type in

docker -v

If you receive an output in the likes of :

Docker version 19.03.5, build 633a0ea

It means you have it installed. If not follow instructions on how to install it for your OS.

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Add additional project dependencies

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GNU License - see the LICENSE file for details