diff --git a/README.md b/README.md index 01bcc0a..9a41bd6 100644 --- a/README.md +++ b/README.md @@ -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 @@ -22,6 +22,7 @@ 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 ``` @@ -29,23 +30,27 @@ 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.