@@ -1,6 +1,6 @@
|
||||
# Just.PreciseMath
|
||||
|
||||
**WIP — repository scaffolding only; no library implementation or tests yet.**
|
||||
**WIP — initial library implementation and one smoke test; numerical correctness is not yet validated.**
|
||||
|
||||
A .NET 10 library being developed for extended-precision floating-point arithmetic
|
||||
using double-double representations (a high/low pair of `double` values), with
|
||||
@@ -42,11 +42,27 @@ dotnet test --solution Just.PreciseMath.slnx -c Release --no-build
|
||||
dotnet format Just.PreciseMath.slnx --verify-no-changes --no-restore
|
||||
```
|
||||
|
||||
The empty test project currently reports no tests (MTP exit code 8); this is not a
|
||||
passing test suite. Once tests exist, add `--coverlet` to the test command for
|
||||
coverage. The benchmark project deliberately builds as a library without source
|
||||
files; add an entry point and benchmark cases, then change `OutputType` to `Exe`
|
||||
and run it in Release without a debugger. No performance results exist yet.
|
||||
The initial smoke test checks that `DoubleDouble.One` exposes high and low
|
||||
components of `1.0` and `0.0`. It exercises the test/coverage pipeline, not the
|
||||
numerical accuracy of the planned library.
|
||||
|
||||
CI collects TRX test results and Cobertura coverage for `Just.PreciseMath` only,
|
||||
excluding test dependencies, and requires at least one test. The `test-results`
|
||||
artifact contains TRX test results and timestamped Cobertura XML coverage reports,
|
||||
retained for three days.
|
||||
Open the workflow run in Gitea Actions and download that artifact. Upload is
|
||||
attempted even when tests fail; no badges or repository-write token are needed.
|
||||
|
||||
To generate the same reports locally:
|
||||
|
||||
```sh
|
||||
dotnet test --solution Just.PreciseMath.slnx -c Release --no-build --minimum-expected-tests 1 --report-xunit-trx --coverlet --coverlet-output-format cobertura --coverlet-include "[Just.PreciseMath]*"
|
||||
```
|
||||
|
||||
Reports are written under each test project's `bin/Release/net10.0/TestResults/`.
|
||||
The benchmark project deliberately builds as a library without source files;
|
||||
add an entry point and benchmark cases, then change `OutputType` to `Exe` and run
|
||||
it in Release without a debugger. No performance results exist yet.
|
||||
|
||||
Package metadata uses the development version `0.1.0-dev`. Licensed under the
|
||||
[MIT License](LICENSE), included in the package.
|
||||
|
||||
Reference in New Issue
Block a user