Update documentation
This commit is contained in:
parent
43078eba79
commit
d249080347
|
@ -242,7 +242,7 @@ article {
|
||||||
color: #666666;
|
color: #666666;
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
letter-spacing: 0.2em;
|
letter-spacing: 0.1em;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
user-select: none;
|
user-select: none;
|
||||||
-moz-user-select: none;
|
-moz-user-select: none;
|
||||||
|
@ -314,7 +314,7 @@ article {
|
||||||
color: #aaa;
|
color: #aaa;
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
letter-spacing: 0.2em;
|
letter-spacing: 0.1em;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
user-select: none;
|
user-select: none;
|
||||||
-moz-user-select: none;
|
-moz-user-select: none;
|
||||||
|
|
|
@ -242,7 +242,7 @@ article {
|
||||||
color: #666666;
|
color: #666666;
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
letter-spacing: 0.2em;
|
letter-spacing: 0.1em;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
user-select: none;
|
user-select: none;
|
||||||
-moz-user-select: none;
|
-moz-user-select: none;
|
||||||
|
@ -314,7 +314,7 @@ article {
|
||||||
color: #aaa;
|
color: #aaa;
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-size: 12px;
|
font-size: 12px;
|
||||||
letter-spacing: 0.2em;
|
letter-spacing: 0.1em;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
user-select: none;
|
user-select: none;
|
||||||
-moz-user-select: none;
|
-moz-user-select: none;
|
||||||
|
|
|
@ -160,14 +160,13 @@ production-ready at this time.</p>
|
||||||
<p>NumericAnnex now requires Xcode 9 beta 5 or a recent development snapshot of
|
<p>NumericAnnex now requires Xcode 9 beta 5 or a recent development snapshot of
|
||||||
Swift 4.0 that includes the revised numeric protocols.</p>
|
Swift 4.0 that includes the revised numeric protocols.</p>
|
||||||
|
|
||||||
<p>It requires either <code>Darwin.C</code> (macOS) or <code>Glibc</code> (Linux) for transcendental
|
<p>On Apple platforms, it requires the Security framework for cryptographically
|
||||||
functions provided by the C standard library and either <code>Security</code> (macOS) or
|
secure random bytes.</p>
|
||||||
<code>Glibc</code> (Linux) for cryptographically secure random bytes.</p>
|
|
||||||
<h2 id='installation' class='heading'>Installation</h2>
|
<h2 id='installation' class='heading'>Installation</h2>
|
||||||
|
|
||||||
<p>After NumericAnnex has been cloned or downloaded locally, build the library with
|
<p>After NumericAnnex has been cloned or downloaded locally, build the library
|
||||||
the command <code>swift build</code> (macOS) or <code>swift build -Xcc -D_GNU_SOURCE</code> (Linux).
|
using the command <code>swift build</code> (macOS) or <code>swift build -Xcc -D_GNU_SOURCE</code>
|
||||||
Tests can be run with the command <code>swift test</code> (macOS) or
|
(Linux). Run tests with the command <code>swift test</code> (macOS) or
|
||||||
<code>swift test -Xcc -D_GNU_SOURCE</code> (Linux). An Xcode project can be generated with
|
<code>swift test -Xcc -D_GNU_SOURCE</code> (Linux). An Xcode project can be generated with
|
||||||
the command <code>swift package generate-xcodeproj</code>.</p>
|
the command <code>swift package generate-xcodeproj</code>.</p>
|
||||||
|
|
||||||
|
@ -220,9 +219,8 @@ counterpart (e.g., <code>Complex128.cbrt(-8) != -2</code>).</p>
|
||||||
<h2 id='future-directions' class='heading'>Future Directions</h2>
|
<h2 id='future-directions' class='heading'>Future Directions</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>[ ] Add more tests, including performance tests</li>
|
<li>Add more tests, including performance tests</li>
|
||||||
<li>[ ] Design and implement additional methods on <code>PRNG</code></li>
|
<li>Design and implement additional methods on <code>PRNG</code></li>
|
||||||
<li>[ ] Design and implement <code>BigInt</code></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id='license' class='heading'>License</h2>
|
<h2 id='license' class='heading'>License</h2>
|
||||||
|
|
||||||
|
|
Binary file not shown.
16
index.html
16
index.html
|
@ -160,14 +160,13 @@ production-ready at this time.</p>
|
||||||
<p>NumericAnnex now requires Xcode 9 beta 5 or a recent development snapshot of
|
<p>NumericAnnex now requires Xcode 9 beta 5 or a recent development snapshot of
|
||||||
Swift 4.0 that includes the revised numeric protocols.</p>
|
Swift 4.0 that includes the revised numeric protocols.</p>
|
||||||
|
|
||||||
<p>It requires either <code>Darwin.C</code> (macOS) or <code>Glibc</code> (Linux) for transcendental
|
<p>On Apple platforms, it requires the Security framework for cryptographically
|
||||||
functions provided by the C standard library and either <code>Security</code> (macOS) or
|
secure random bytes.</p>
|
||||||
<code>Glibc</code> (Linux) for cryptographically secure random bytes.</p>
|
|
||||||
<h2 id='installation' class='heading'>Installation</h2>
|
<h2 id='installation' class='heading'>Installation</h2>
|
||||||
|
|
||||||
<p>After NumericAnnex has been cloned or downloaded locally, build the library with
|
<p>After NumericAnnex has been cloned or downloaded locally, build the library
|
||||||
the command <code>swift build</code> (macOS) or <code>swift build -Xcc -D_GNU_SOURCE</code> (Linux).
|
using the command <code>swift build</code> (macOS) or <code>swift build -Xcc -D_GNU_SOURCE</code>
|
||||||
Tests can be run with the command <code>swift test</code> (macOS) or
|
(Linux). Run tests with the command <code>swift test</code> (macOS) or
|
||||||
<code>swift test -Xcc -D_GNU_SOURCE</code> (Linux). An Xcode project can be generated with
|
<code>swift test -Xcc -D_GNU_SOURCE</code> (Linux). An Xcode project can be generated with
|
||||||
the command <code>swift package generate-xcodeproj</code>.</p>
|
the command <code>swift package generate-xcodeproj</code>.</p>
|
||||||
|
|
||||||
|
@ -220,9 +219,8 @@ counterpart (e.g., <code>Complex128.cbrt(-8) != -2</code>).</p>
|
||||||
<h2 id='future-directions' class='heading'>Future Directions</h2>
|
<h2 id='future-directions' class='heading'>Future Directions</h2>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>[ ] Add more tests, including performance tests</li>
|
<li>Add more tests, including performance tests</li>
|
||||||
<li>[ ] Design and implement additional methods on <code>PRNG</code></li>
|
<li>Design and implement additional methods on <code>PRNG</code></li>
|
||||||
<li>[ ] Design and implement <code>BigInt</code></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id='license' class='heading'>License</h2>
|
<h2 id='license' class='heading'>License</h2>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue