Giter Club home page Giter Club logo

geolib's Introduction

GeoLib - basic 2D and 3D geometry

CI pipeline status

This library contains basic vector arithmetic and helper functions. It is built to be extended with any other geometry based function used in the car/simulation.

Dependencies

  • Unix based OS

How to install

Do not use the script given in the repo. It is used for CI/CD only.

The library will be installed in your global path, therefore you can pick a directory outside your repository for the installation. If you do so, add the library with a link to your dependency list in the README.md.

In your directory of choice:

git clone [email protected]:irt-driverless/geolib.git
mkdir -p geolib/build && cd geolib/build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++ ..
make
make install

If you want to uninstall, use make uninstall in the build directory.

How to use in your project

Make sure you followed the install steps line by line. In your CMakeLists.txt file, add the following lines after your target.

# header files for all librarys
target_include_directories(<exe_target> PUBLIC /usr/local/include)

# the librarys you want to link
target_link_libraries(<exe_target> PUBLIC /usr/local/lib/libgeo.a)

How to extend

If you have a geometry function that is needed for your package or node

  1. clone this repo git clone https://gitlab.com/irt-driverless/geolib.git
  2. make a feature-branch git checkout -b feature/<your_feature>
  3. add tests for your function (tests/tests.cpp)
  4. implement your function
  5. push your branch and make a merge-request for master

Your request will be checked and merged.

geolib's People

Contributors

zwergofphoenix avatar stelzo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.