These are some files that complement or extend the C++ library:
cxx.cpp
add explicit handlers for C++ API functions, to be sure no other heavy implementations are pulled from the (huge) standard library.
The project is hosted on GitHub as micro-os-plus/libs-cpp-xpack.
This page is addressed to developers who plan to include this source library into their own projects.
For maintainer info, please see the README-MAINTAINER file.
As a source library 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.
A recent xpm, which is a portable Node.js command line application.
For details please follow the instructions in the xPack install page.
Note: the package will be available from npmjs.com at a later date.
For now, it can be installed from GitHub:
cd my-project
xpm init # Unless a package.json is already present
xpm install github:micro-os-plus/libs-cpp-xpack
When ready, this package will be available as
@micro-os-plus/libs-cpp
from the npmjs.com
registry:
cd my-project
xpm init # Unless a package.json is already present
xpm install @micro-os-plus/libs-cpp@latest
ls -l xpacks/micro-os-plus-libs-cpp
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 my-project
git init # Unless already a Git project
mkdir -p xpacks
git submodule add https://github.com/micro-os-plus/libs-cpp-xpack.git \
xpacks/micro-os-plus-libs-cpp
Apart from the unused master
branch, there are two active branches:
xpack
, with the latest stable version (default)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
.
TBD
The C++ definitions are fully functional.
To include this package in a project, consider the following details.
The following folders should be passed to the compiler during the build:
include
TODO: list the available headers
The source files to be added to the build are:
TODO
TBD
-std=c++20
or higher for C++ sources-std=c11
for C sources
TBD
TBD
TBD
- none
TBD
According to semver rules:
Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.
The incompatible changes, in reverse chronological order, are:
- TBD
The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.