]> git.proxmox.com Git - ceph.git/blobdiff - ceph/src/boost/libs/qvm/README.md
update ceph source to reef 18.1.2
[ceph.git] / ceph / src / boost / libs / qvm / README.md
index 40185be4e5e61aa9ef68b8db122e995bf12fceb9..0205b27c7d98cf8cf81964767804c8566390f90a 100644 (file)
@@ -1,12 +1,33 @@
-QVM: Generic C++ library for working with Quaternions, Vectors and Matrices
+# QVM
 
-Official documentation: https://boostorg.github.io/qvm/
+> A generic C++ library for working with `Q`uaternions, `V`ectors and `M`atrices.
+
+## Documentation
+
+https://boostorg.github.io/qvm/
+
+## Features
 
 * Emphasis on 2, 3 and 4-dimensional operations needed in graphics, video games and simulation applications.
-* Free function templates operate on any compatible user-defined quaternion, vector or matrix type.
-* Quaternion, vector and matrix types from different libraries or subsystems can be safely mixed in the same expression.
-* Type-safe mapping between compatible lvalue types with no temporary objects; e.g. transpose remaps the elements, rather than transforming the matrix.
+* Free function templates operate on any compatible user-defined Quaternion, Vector or Matrix type.
+* Enables Quaternion, Vector and Matrix types from different libraries to be safely mixed in the same expression.
+* Type-safe mapping between compatible lvalue types with no temporary objects; f.ex. transpose remaps the access to the elements, rather than transforming the matrix.
+* Requires only {CPP}03.
+* Zero dependencies.
+
+## Support
+
+* [cpplang on Slack](https://Cpplang.slack.com) (use the `#boost` channel)
+* [Boost Users Mailing List](https://lists.boost.org/mailman/listinfo.cgi/boost-users)
+* [Boost Developers Mailing List](https://lists.boost.org/mailman/listinfo.cgi/boost)
+
+## Distribution
+
+Besides GitHub, there are two other distribution channels:
 
-Copyright (c) 2018 Emil Dotchevski. Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).
+* QVM is included in official [Boost](https://www.boost.org/) releases.
+* For maximum portability, the library is also available in single-header format, in two variants (direct download links):
+       * [qvm.hpp](https://boostorg.github.io/qvm/qvm.hpp): single header containing the complete QVM source, including the complete set of swizzling overloads.
+       * [qvm_lite.hpp](https://boostorg.github.io/qvm/qvm_lite.hpp): single header containing everything except for the swizzling overloads.
 
-Please post questions and feedback on the Boost Developers Mailing List.
+Copyright 2008-2022 Emil Dotchevski and Reverge Studios, Inc. Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).