Skip to content

Commit

Permalink
Minor readme update
Browse files Browse the repository at this point in the history
Signed-off-by: ClemensLinnhoff <[email protected]>
  • Loading branch information
ClemensLinnhoff committed Nov 11, 2024
1 parent c15604f commit ebaad77
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# osi-utilities
# OSI Utilities

![Build](https://github.com/OpenSimulationInterface/osi-utilities/actions/workflows/ubuntu.yml/badge.svg)

Utility library providing companion tools, helpers and best practices for working with the [Open Simulation Interface (OSI)](https://github.com/OpenSimulationInterface/open-simulation-interface/c) standard.
Utility library providing companion tools, helpers and best practices for working with the [ASAM Open Simulation Interface (OSI)](https://github.com/OpenSimulationInterface/open-simulation-interface/c) standard.

## Features
- Cross-platform C++ library and Python APIs
- **Note:** Python API is planned but not yet implemented
- **Note:** Windows support is planned but not yet tested, contributions welcome!
- Easily deal with OSI data and files into your own projects
- Easily integrate dealing with OSI data and trace files into your own projects
- More OSI utility features planned, feature requests and pull requests welcome!

## Build Instructions
Expand All @@ -22,30 +22,35 @@ Utility library providing companion tools, helpers and best practices for workin
- [Protobuf](https://github.com/protocolbuffers/protobuf)

**Note:** On Debian/Ubuntu, you can install the required dependencies using the following commands:

```bash
sudo apt install build-essential cmake libzstd-dev liblz4-dev protobuf-compiler
```

### Build

Clone the repository

```bash
git clone https://github.com/OpenSimulationInterface/osi-utilities.git
```

Create build directory and configure using CMake

```bash
mkdir build && cd build
cmake ..
```

Build using CMake

```bash
cmake --build . -j4
```


## Contributing

We welcome contributions! This library aims to grow alongside OSI to provide the community with helpful tools and utilities. If you have ideas for new features or improvements, you are encouraged to open issues and submit pull requests.
We welcome contributions!
This library aims to grow alongside ASAM OSI to provide the community with helpful tools and utilities.
If you have ideas for new features or improvements, you are encouraged to open issues and submit pull requests.

0 comments on commit ebaad77

Please sign in to comment.