Skip to content

RedNicStone/libosmio-headers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

libosmio-headers - Optimized Static Multi I/O library headers

Headers for libosmio loaders and installable client drivers

This repository contains all public include headers for libosmio.
These headers can be used when building custom loaders and ICD's for libosmio. They are also used to generate documentation files.

Who is this repository for?

This repo, libosmio-headers, is provided as an easy way to create custom loaders and ICD's for the osmio ecosystem.
The target audience is developers wanting to extend or implement osmio functionality. If you are looking to use osmio as a library in your own project, take a look at the meta repo.

What this repo is used for:

Using this repository to provide public headers

This repository uses CMake, so including it in you project as public headers is almost as easy as adding a CMake project.
To include osmio headers as public header files to your project, see these examples:

For a custom loader implementation

Todo: Add loader include example

For a custom ICD

Todo: Add ICD include example

Finding documentation on this repository

All documentation on osmio functions as well as how to build your custom loader and ICD can be found in the documentation repo.

Contributing to this repository

Unfortunately contributions to this repository will be accepted only under rare circumstances.
Since this repo holds the API footprint of libosmio, any change is likely to impact or even break existing loaders and ICDs.
The readme and CMake files are unlikely to have any impact though, so feel free to open contributions to these.

Opening issues on this repository

Issues regarding the header files provided by this repository are likely to force an API change, so they fall under the same restrictions as contributing.

Footnotes

  1. Linking against osmio this way is not recommended. If you want to link libosmio dynamically, install a loader on your system and link against those headers.

About

Header files for libosmio and API registry

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published