README.md

A source xPack with the µOS++ C++ memory allocators

This project includes files several C++ memory allocators, to be used in applications an internally in the µOS++ RTOS.

The project is hosted on GitHub as micro-os-plus/memory-allocators-xpack.

Maintainer info

This page is addressed to developers who plan to include this package into their own projects.

For maintainer infos, please see the README-MAINTAINER file.

Install

As a source xPacks, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.

Prerequisites

A recent xpm, which is a portable Node.js command line application.

For details please follow the instructions in the install page.

xpm

Note: the package will be available from npmjs.com at a later date.

For now, it can be installed from GitHub:

$ cd <project>
$ xpm init # Unless a package.json is already present

$ xpm install github:micro-os-plus/memory-allocators-xpack

When ready, this package will be available as @micro-os-plus/memory-allocators from the npmjs.com registry:

$ cd <project>
$ xpm init # Unless a package.json is already present

$ xpm install @micro-os-plus/memory-allocators@latest

Git submodule

If, for any reason, xpm is not available, the next recommended solution is to link it as a Git submodule below an xpacks folder.

$ cd <project>
$ git init # Unless already a Git project
$ mkdir -p xpacks

$ git submodule add https://github.com/micro-os-plus/memory-allocators-xpack.git \
  xpacks/micro-os-plus-memory-allocators

Branches

Apart from the unused master branch, there are two active branches:

• xpack, with the latest stable version
• xpack-develop, with the current development version

All development is done in the xpack-develop branch, and contributions via Pull Requests should be directed to this branch.

When new releases are published, the xpack-develop branch is merged into xpack.

User info

TBD

Status

The memory allocators are fully functional.

Build & integration info

To include this package in a project, consider the following details.

Source folders

• src

Include folders

• include

TODO: list the available headeres

Preprocessor definitions

TBD

Compiler options

• -std=c++17 or higher for C++ sources
• -std=c11 for C sources

Namespaces

TBD

Classes

TBD

Examples

TBD

Known problems

• none

Tests

TBD

License

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.