56 lines
1.0 KiB
Markdown
56 lines
1.0 KiB
Markdown
# Overview
|
|
|
|
This is a C library that provides a multithreaded MCTP based message passing
|
|
framework.
|
|
|
|
# Supported Operating System Versions
|
|
|
|
- Ubuntu 23.10
|
|
- Fedora 38, 39
|
|
|
|
# Building
|
|
|
|
1. Install OS libraries
|
|
|
|
Install the following build packages to compile the software on the following
|
|
operating systems.
|
|
|
|
**Ubuntu:**
|
|
|
|
```bash
|
|
apt install build-essential
|
|
```
|
|
|
|
**Fedora:**
|
|
|
|
```bash
|
|
```
|
|
|
|
2. Build Dependencies
|
|
|
|
This library is dependent upon the following projects.
|
|
|
|
- [array_utils](https://github.com/JackrabbitLabs/array_utils)
|
|
- [time_utils](https://github.com/JackrabbitLabs/time_utils)
|
|
- [ptr_queue](https://github.com/JackrabbitLabs/ptr_queue)
|
|
- [emapi](https://github.com/JackrabbitLabs/emapi)
|
|
- [fmapi](https://github.com/JackrabbitLabs/fmapi)
|
|
|
|
For each of these repositories, in the order listed, clone and execute:
|
|
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
This will install a library (.a) and header file to the standard os location
|
|
(e.g. /usr/local/include, /usr/local/lib)
|
|
|
|
3. Build
|
|
|
|
After building the required dependencies run:
|
|
|
|
```bash
|
|
make
|
|
```
|
|
|