Skip to content

Commit

Permalink
Start writing README + license [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
costashatz committed Feb 2, 2024
1 parent 1c596c6 commit 3703cd5
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 11 deletions.
30 changes: 30 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
BSD 2-Clause License

Copyright (c) 2022-2024 Computational Intelligence Lab, University of Patras, Greece
Copyright (c) 2023-2024 Laboratory of Automation and Robotics, University of Patras, Greece
Copyright (c) 2017-2018 LARSEN Team, Inria, France
Copyright (c) 2017-2024 Konstantinos Chatzilygeroudis
Copyright (c) 2017-2024 Jean-Baptiste Mouret
Copyright (c) 2023-2024 Dionis Totsila
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
robot_dart [![Build Status](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml/badge.svg?branch=master)](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml)
RobotDART [![Build Status](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml/badge.svg?branch=master)](https://github.com/resibots/robot_dart/actions/workflows/ci_linux.yml)
=====================================================================================================================================================================================================

### CAUTION: The library is under-going a serious re-structure and development. Expect breaking of API/ABI, and out-of-date guides. We will soon provide a new release with many new features and a proper documentation.
RobotDART is a C++ robot simulator (with optional Python bindings) built on top of the [DART] physics engine. The RobotDART simulator is intended to be used by Robotics and Machine Learning researchers who want to write controllers or test learning algorithms without the delays and overhead that usually comes with other simulators (e.g., Gazebo, Coppelia-sim).

#### This repo contains a generic wrapper around the [DART] simulator.
## Documentation

Documentation is available at: [https://resibots.eu/robot_dart/](https://resibots.eu/robot_dart/)

## Authors

- Author/Maintainer: Konstantinos Chatzilygeroudis
- Active contributors: Jean-Baptiste Mouret
- Author/Maintainer: Konstantinos Chatzilygeroudis (University of Patras)
- Active contributors: Dionis Totsila (Inria and University of Patras), Jean-Baptiste Mouret (Inria)
- Other contributors: Antoine Cully, Vassilis Vassiliades, Vaios Papaspyros

### Using the code
## Acknowledgments

This work was partly supported by the [Hellenic Foundation for Research and Innovation](https://www.elidek.gr/en/homepage/) (H.F.R.I.) under the "3rd Call for H.F.R.I. Research Projects to support Post-Doctoral Researchers" (Project Acronym: [NOSALRO](), Project Number: 7541).

<p align="center">
<img src="https://www.elidek.gr/wp-content/themes/elidek/images/elidek_logo_en.png" alt="logo_elidek"/>
<p/>

This work was partly supported by the ResiBots ERC Project (http://www.resibots.eu).

<p aling="center">
<img src="http://resibots.eu/_static/resibots_logo_black_200px.png" alt="logo_resibots"/>
</p>

Please look at the [installation guide](docs/installation.md). You will find detailed guidelines on how to properly install all the dependencies, compile the code and run the examples. There is also a short [tutorial](docs/tutorial.md) where the basics of this small library are explained through coding a small example. Moreover, a small [guide](docs/guide.md) provides a brief overview of the main classes and functionality of the library. Finally, there exist python bindings of the library, located [here](src/python) (see the examples for usage).

## LICENSE
## License

[CeCILL]
[BSD 2-Clause "Simplified" License](https://opensource.org/license/bsd-2-clause/)

[CeCILL]: http://www.cecill.info/index.en.html
[DART]: http://dartsim.github.io/
2 changes: 1 addition & 1 deletion paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ authors:
corresponding: true
affiliation: "1, 2" # (Multiple affiliations must be quoted)
- name: Dionis Totsila
# orcid: 0000-0002-2513-027X
orcid: 0009-0008-0664-2676
equal-contrib: false
corresponding: false
affiliation: "3, 4"
Expand Down

0 comments on commit 3703cd5

Please sign in to comment.