Auto-generated commit

README.md

@@ -45,12 +45,14 @@ npm install @stdlib/constants
 
 Alternatively,
 
--   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm` branch][esm-url].
--   If you are using Deno, visit the [`deno` branch][deno-url].
--   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
+-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
+-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
+-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
 
 The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
 
+To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
+
 </section>
 
 <section class="usage">
@@ -195,8 +197,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/constants/tree/deno
+[deno-readme]: https://github.com/stdlib-js/constants/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/constants/tree/umd
+[umd-readme]: https://github.com/stdlib-js/constants/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/constants/tree/esm
+[esm-readme]: https://github.com/stdlib-js/constants/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/constants/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/constants/main/LICENSE

branches.md

@@ -24,9 +24,9 @@ This repository has the following branches:
 
 -   **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
 -   **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
--   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
--   **deno**: [Deno][deno-url] branch for use in Deno.
--   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
+-   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
+-   **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
+-   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
 
 The following diagram illustrates the relationships among the above branches:
 
@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
 [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants
 [production-url]: https://github.com/stdlib-js/constants/tree/production
 [deno-url]: https://github.com/stdlib-js/constants/tree/deno
+[deno-readme]: https://github.com/stdlib-js/constants/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/constants/tree/umd
-[esm-url]: https://github.com/stdlib-js/constants/tree/esm
+[umd-readme]: https://github.com/stdlib-js/constants/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/constants/tree/esm
+[esm-readme]: https://github.com/stdlib-js/constants/blob/esm/README.md

complex128/README.md

@@ -43,7 +43,9 @@ var c = constants;
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`NAN`][@stdlib/constants/complex128/nan]</span><span class="delimiter">: </span><span class="description">canonical double-precision complex floating-point `NaN`.</span>
 -   <span class="signature">[`NUM_BYTES`][@stdlib/constants/complex128/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a 128-bit complex number.</span>
+-   <span class="signature">[`ZERO`][@stdlib/constants/complex128/zero]</span><span class="delimiter">: </span><span class="description">double-precision complex floating-point zero.</span>
 
 </div>
 
@@ -86,8 +88,12 @@ console.log( objectKeys( constants ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/constants/complex128/nan]: https://github.com/stdlib-js/constants/tree/main/complex128/nan
+
 [@stdlib/constants/complex128/num-bytes]: https://github.com/stdlib-js/constants/tree/main/complex128/num-bytes
 
+[@stdlib/constants/complex128/zero]: https://github.com/stdlib-js/constants/tree/main/complex128/zero
+
 <!-- </toc-links> -->
 
 </section>

complex64/README.md

@@ -43,7 +43,9 @@ var c = constants;
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`NAN`][@stdlib/constants/complex64/nan]</span><span class="delimiter">: </span><span class="description">canonical single-precision complex floating-point `NaN`.</span>
 -   <span class="signature">[`NUM_BYTES`][@stdlib/constants/complex64/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a 64-bit complex number.</span>
+-   <span class="signature">[`ZERO`][@stdlib/constants/complex64/zero]</span><span class="delimiter">: </span><span class="description">single-precision complex floating-point zero.</span>
 
 </div>
 
@@ -86,8 +88,12 @@ console.log( objectKeys( constants ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/constants/complex64/nan]: https://github.com/stdlib-js/constants/tree/main/complex64/nan
+
 [@stdlib/constants/complex64/num-bytes]: https://github.com/stdlib-js/constants/tree/main/complex64/num-bytes
 
+[@stdlib/constants/complex64/zero]: https://github.com/stdlib-js/constants/tree/main/complex64/zero
+
 <!-- </toc-links> -->
 
 </section>

float32/README.md

@@ -51,6 +51,7 @@ var c = constants;
 -   <span class="signature">[`MAX_SAFE_INTEGER`][@stdlib/constants/float32/max-safe-integer]</span><span class="delimiter">: </span><span class="description">maximum safe single-precision floating-point integer.</span>
 -   <span class="signature">[`MAX`][@stdlib/constants/float32/max]</span><span class="delimiter">: </span><span class="description">maximum single-precision floating-point number.</span>
 -   <span class="signature">[`MIN_SAFE_INTEGER`][@stdlib/constants/float32/min-safe-integer]</span><span class="delimiter">: </span><span class="description">minimum safe single-precision floating-point integer.</span>
+-   <span class="signature">[`NAN`][@stdlib/constants/float32/nan]</span><span class="delimiter">: </span><span class="description">single-precision floating-point `NaN`.</span>
 -   <span class="signature">[`NINF`][@stdlib/constants/float32/ninf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point negative infinity.</span>
 -   <span class="signature">[`NUM_BYTES`][@stdlib/constants/float32/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a single-precision floating-point number.</span>
 -   <span class="signature">[`PINF`][@stdlib/constants/float32/pinf]</span><span class="delimiter">: </span><span class="description">single-precision floating-point positive infinity.</span>
@@ -118,6 +119,8 @@ console.log( objectKeys( constants ) );
 
 [@stdlib/constants/float32/min-safe-integer]: https://github.com/stdlib-js/constants/tree/main/float32/min-safe-integer
 
+[@stdlib/constants/float32/nan]: https://github.com/stdlib-js/constants/tree/main/float32/nan
+
 [@stdlib/constants/float32/ninf]: https://github.com/stdlib-js/constants/tree/main/float32/ninf
 
 [@stdlib/constants/float32/num-bytes]: https://github.com/stdlib-js/constants/tree/main/float32/num-bytes

float64/README.md

@@ -85,6 +85,7 @@ var c = constants;
 -   <span class="signature">[`MIN_BASE2_EXPONENT`][@stdlib/constants/float64/min-base2-exponent]</span><span class="delimiter">: </span><span class="description">the minimum biased base 2 exponent for a normal double-precision floating-point number.</span>
 -   <span class="signature">[`MIN_LN`][@stdlib/constants/float64/min-ln]</span><span class="delimiter">: </span><span class="description">natural logarithm of the smallest **normalized** double-precision floating-point number.</span>
 -   <span class="signature">[`MIN_SAFE_INTEGER`][@stdlib/constants/float64/min-safe-integer]</span><span class="delimiter">: </span><span class="description">minimum safe double-precision floating-point integer.</span>
+-   <span class="signature">[`NAN`][@stdlib/constants/float64/nan]</span><span class="delimiter">: </span><span class="description">double-precision floating-point `NaN`.</span>
 -   <span class="signature">[`NINF`][@stdlib/constants/float64/ninf]</span><span class="delimiter">: </span><span class="description">double-precision floating-point negative infinity.</span>
 -   <span class="signature">[`NUM_BYTES`][@stdlib/constants/float64/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a double-precision floating-point number.</span>
 -   <span class="signature">[`PHI`][@stdlib/constants/float64/phi]</span><span class="delimiter">: </span><span class="description">golden ratio.</span>
@@ -229,6 +230,8 @@ console.log( objectKeys( constants ) );
 
 [@stdlib/constants/float64/min-safe-integer]: https://github.com/stdlib-js/constants/tree/main/float64/min-safe-integer
 
+[@stdlib/constants/float64/nan]: https://github.com/stdlib-js/constants/tree/main/float64/nan
+
 [@stdlib/constants/float64/ninf]: https://github.com/stdlib-js/constants/tree/main/float64/ninf
 
 [@stdlib/constants/float64/num-bytes]: https://github.com/stdlib-js/constants/tree/main/float64/num-bytes