add license

LICENSE

@@ -0,0 +1,50 @@
+MIT License
+
+Copyright (c) 2021 Lars Berscheid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+---
+
+
+Copyright (c) 2009-2021 Lars Berscheid
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * 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.
+    * Neither the name of the FIRST nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY FIRST AND CONTRIBUTORS``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY NONINFRINGEMENT AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FIRST 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.

README.md

@@ -1,3 +1,43 @@
-# Ruckig
+<div align="center">
+  <h1 align="center">Ruckig</h1>
+  <h3 align="center">
+    Online Trajectory Generation. Real-time. Jerk-constrained.
+  </h3>
+</div>
+<p align="center">
+  <a href="https://github.com/pantor/ruckig/actions">
+    <img src="https://github.com/pantor/ruckig/workflows/CI/badge.svg" alt="CI">
+  </a>
 
-Online Trajectory Generation. Real-time. Jerk-constrained.
+  <a href="https://github.com/pantor/frankx/issues">
+    <img src="https://img.shields.io/github/issues/pantor/frankx.svg" alt="Issues">
+  </a>
+
+  <a href="https://github.com/pantor/frankx/releases">
+    <img src="https://img.shields.io/github/v/release/pantor/frankx.svg?include_prereleases&sort=semver" alt="Releases">
+  </a>
+
+  <a href="https://github.com/pantor/frankx/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="LGPL">
+  </a>
+</p>
+
+
+## Installation
+
+```bash
+mkdir -p build
+cd build
+cmake -DBUILD_TYPE=Release ..
+make
+make install
+```
+
+## Development
+
+Frankx is written in C++17. It is currently tested against following versions
+
+- Eigen v3.3.9
+- Catch2 v2.13.3 (only for testing)
+- Reflexxes v1.2.7 (only for testing)
+- Pybind11 v2.6.0 (only for prototyping)