Browse Source

README.md

master
heck 5 months ago
commit
e6e775d4b1
1 changed files with 40 additions and 0 deletions
  1. +40
    -0
      README.md

+ 40
- 0
README.md View File

@ -0,0 +1,40 @@
# libpEpCxx11
A collection of commonly re-usable C++ code
Important: No dependencies allowed except c++ standard libraries
## Resources
* Repository: https://gitea.pep.foundation/pEp.foundation/libpEpCxx11/
* Change management: <TODO: JIRA link here>
## Requirements & Platforms
* License: GPL3
* C++ standard: C++11
* supported compilers: at least gcc and clang (both have to work)
* Build sytem: GNU Make – Platforms: Linux, macOS
** Target: static library libpEpCxx.a
* Windows and Android builds will be done separatly
## Public API
* defined in `namespace pEp::CXX`
* header files are installed in `PREFIX/include/pEp/` and are used via `#include <pEp/filename.hh>`
## Coding Conventions
The coding conventions are expressed in the top level:
* .clang-format
* .clang-tidy
Code committed or submitted via PR will be rejected if not adhering to these coding conventions
Additionally:
* Include guards: #ifdef/#define style (not #pragma once), naming key: `LIBPEPCXX1_<FILENAME>_{HH|HXX}`

Loading…
Cancel
Save