From d824be6822449b361d875fe2a7e7f006b16d31fa Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Wed, 25 Oct 2023 14:13:00 +0200 Subject: [PATCH] docs: ISO papers reference added to docs and README --- README.md | 12 +++++++++--- docs/index.md | 18 ++++++++++++------ 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 33b60c756..6a5c783cc 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,15 @@ # `mp-units` - A Physical Quantities and Units library for C++ -**The mp-units library might be the subject of ISO standardization for C++29. -More on this can be found in ISO C++ paper [P1935](https://wg21.link/p1935). -We are actively looking for parties interested in field trialing the library.** +**The mp-units library might be the subject of ISO standardization for C++29. More on this can +be found in the following ISO C++ proposals:** + +- [P1935: A C++ Approach to Physical Units](https://wg21.link/p1935), +- [P2980: A motivation, scope, and plan for a physical quantities and units library](https://wg21.link/p2980), +- [P2981: Improving our safety with a physical quantities and units library](https://wg21.link/p2981), +- [P2982: `std::quantity` as a numeric type](https://wg21.link/p2982). + +**We are actively looking for parties interested in field-trialing the library.** [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mpusz/mp-units) diff --git a/docs/index.md b/docs/index.md index 9a376e5ef..1c82cd5ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,23 @@ # Welcome to **mp-units**! -**mp-units** is a compile-time enabled feature-rich Modern C++ header-only library that provides -compile-time dimensional analysis and unit/quantity manipulation. Its key strengths include safety, -performance, and developer experience. +**mp-units** is a compile-time enabled feature-rich Modern C++ modular/header-only library that +provides compile-time dimensional analysis and unit/quantity manipulation. Its key strengths +include safety, performance, and developer experience. The library source code is hosted on [GitHub](https://github.com/mpusz/mp-units) with a permissive [MIT license](https://github.com/mpusz/units/blob/master/LICENSE.md). -!!! important "Help needed!" +!!! important "Important: Help needed!" The **mp-units** library might be the subject of ISO standardization for C++29. More on this can - be found in the ISO C++ proposal [P1935](https://wg21.link/p1935). We are actively looking for - parties interested in field-trialing the library. + be found in the following ISO C++ proposals: + + - [P1935: A C++ Approach to Physical Units](https://wg21.link/p1935), + - [P2980: A motivation, scope, and plan for a physical quantities and units library](https://wg21.link/p2980), + - [P2981: Improving our safety with a physical quantities and units library](https://wg21.link/p2981), + - [P2982: `std::quantity` as a numeric type](https://wg21.link/p2982). + + We are actively looking for parties interested in field-trialing the library. ??? info "Supported compilers"