diff options
| author | William A. Kennington III <wak@google.com> | 2019-06-27 15:25:41 -0700 |
|---|---|---|
| committer | William A. Kennington III <wak@google.com> | 2019-06-27 15:31:30 -0700 |
| commit | 7d75a48513560d8735bb3d795bb8872af276ee43 (patch) | |
| tree | d83fe7c2ddfc344ec75c47294e8ba80e40c70d61 | |
| parent | 8f1700e7ab886ed602c371265ff2c653a2deb485 (diff) | |
| download | stdplus-7d75a48513560d8735bb3d795bb8872af276ee43.tar.gz stdplus-7d75a48513560d8735bb3d795bb8872af276ee43.zip | |
README: Expand documentation to include an overview of repo contents
Change-Id: Id719a64f69de8cb5d08efc8c7d1b654790bb32fb
Signed-off-by: William A. Kennington III <wak@google.com>
| -rw-r--r-- | README.md | 9 |
1 files changed, 8 insertions, 1 deletions
@@ -1,7 +1,14 @@ # stdplus stdplus is a c++ project containing commonly used classes and functions -for the Linux platform. +for the Linux platform. Note the goals of this project are to implement only +the minimum set of features needed by the OpenBMC project and other users. You +may find the included set of functions currently quite sparse. + +This project provides the following primitives: +* A [movable](src/stdplus/handle/managed.hpp) and [copyable](src/stdplus/handle/copyable.hpp) RAII helper wrapper which is used for wrapping c-native types that have custom destruction or copy reference logic. +* [Functions](src/stdplus/signal.hpp) for trivially configuring signals without having to do the normal signal set operations from libc +* [C-Style Error Handler](src/stdplus/util/cexec.hpp) that wrap c-style functions which return errnos and negative error values into functions that throw c++ exceptions. ## Dependencies |
