diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 436c88abb..14f7dd1d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,9 @@ additions to source code and other files under source control, shall be made via pull requests. A pull request must always be reviewed and merged by someone other than its author. +Before a pull request can be approved and merged into the code base, the author +must sign the "OSP Contributor License Agreement". This agreement is pending, but +will be included in this repository with guidelines once concluded. Programming language and style ------------------------------ @@ -83,15 +86,15 @@ The following are *recommendations*: Directory structure ------------------- -The source directories are organised as follows: +`libcosim` follows the [pitchfork layout](https://api.csswg.org/bikeshed/?force=1&url=https://raw.githubusercontent.com/vector-of-bool/pitchfork/develop/data/spec.bs) +and the source directories are organised as follows: * `cmake/`: CMake scripts and other build system files. + * `data/`: Additional files included in revision control, but not explicitly code. * `include/`: Header files that define the public API. - * `src/cpp/`: Source code for the C++ library. - * `src/c/`: Source code for the C library. - * `test/cpp/`: Test suite for the C++ library. - * `test/c/`: Test suite for the C library. - * `test/data`: Resources used by the test suites. + * `src/cosim/`: Source code with merged header placement for internal headers. + * `tests/`: Test suite for the library. + * `test/data`: Resources used by the test suite. File names @@ -100,8 +103,6 @@ Use the following file extensions: * `.hpp` for C++ headers * `.cpp` for C++ sources - * `.h` for pure C headers - * `.c` for pure C sources Use underscores to separate words in file names (`like_this.hpp`). diff --git a/README.md b/README.md index 3ccacc879..45e82e9ae 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ libcosim - A co-simulation library for C++ ========================================== +![libcosim CI Conan](https://github.com/open-simulation-platform/libcosim/workflows/libcosim%20CI%20Conan/badge.svg) +![libcosim CI CMake](https://github.com/open-simulation-platform/libcosim/workflows/libcosim%20CI%20CMake/badge.svg) -This repository contains two libraries: - - * A C++ library for distributed co-simulations. - * A C library which wraps and exposes a subset of the C++ library's functions. - +This repository contains the OSP C++ library for co-simulations. + See [`CONTRIBUTING.md`] for contributor guidelines and [`LICENSE`] for terms of use.