125 lines
3.6 KiB
HTML
125 lines
3.6 KiB
HTML
|
<!DOCTYPE html>
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<meta charset="utf-8">
|
||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
<meta name="generator" content="Crystal Docs 0.29.0">
|
||
|
|
||
|
|
||
|
<link href="css/style.css" rel="stylesheet" type="text/css">
|
||
|
|
||
|
<script type="text/javascript" src="js/doc.js"></script>
|
||
|
<script type="text/javascript">
|
||
|
CrystalDoc.base_path = "";
|
||
|
</script>
|
||
|
|
||
|
<meta id="repository-name" content="github.com/watzon/apatite">
|
||
|
<title>README - github.com/watzon/apatite</title>
|
||
|
</head>
|
||
|
<body>
|
||
|
|
||
|
<div class="sidebar">
|
||
|
<div class="sidebar-header">
|
||
|
<div class="search-box">
|
||
|
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
|
||
|
</div>
|
||
|
|
||
|
<div class="repository-links">
|
||
|
<a href="index.html">README</a>
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
<div class="search-results" class="hidden">
|
||
|
<ul class="search-list"></ul>
|
||
|
</div>
|
||
|
|
||
|
<div class="types-list">
|
||
|
<ul>
|
||
|
|
||
|
<li class="parent " data-id="github.com/watzon/apatite/Apatite" data-name="apatite">
|
||
|
<a href="Apatite.html">Apatite</a>
|
||
|
|
||
|
<ul>
|
||
|
|
||
|
<li class="parent " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra" data-name="apatite::linearalgebra">
|
||
|
<a href="Apatite/LinearAlgebra.html">LinearAlgebra</a>
|
||
|
|
||
|
<ul>
|
||
|
|
||
|
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix" data-name="apatite::linearalgebra::matrix">
|
||
|
<a href="Apatite/LinearAlgebra/Matrix.html">Matrix</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/NDArray" data-name="apatite::linearalgebra::ndarray">
|
||
|
<a href="Apatite/LinearAlgebra/NDArray.html">NDArray</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Vector" data-name="apatite::linearalgebra::vector">
|
||
|
<a href="Apatite/LinearAlgebra/Vector.html">Vector</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<li class=" " data-id="github.com/watzon/apatite/Array" data-name="array(t)">
|
||
|
<a href="Array.html">Array</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<div class="main-content">
|
||
|
<h1>Apatite</h1>
|
||
|
|
||
|
<p>Apatite is meant to be a collecion of mathmatical and scientific computing algorithms for the Crystal programming language. I don't expect it to ever reach the level of completeness as numpy, but hopefully it can save some people the trouble of implementing these methods on their own.</p>
|
||
|
|
||
|
<h2>Installation</h2>
|
||
|
|
||
|
<ol><li>Add the dependency to your <code>shard.yml</code>:</li></ol>
|
||
|
|
||
|
<p><code></code>`yaml
|
||
|
dependencies:</p>
|
||
|
|
||
|
<pre><code> apatite:
|
||
|
github: watzon<span class="s">/apatite</code></pre>
|
||
|
|
||
|
<p><code></code>`</p>
|
||
|
|
||
|
<ol><li>Run <code>shards install</code></li></ol>
|
||
|
|
||
|
<h2>Usage</h2>
|
||
|
|
||
|
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">"apatite"</span></code></pre>
|
||
|
|
||
|
<p><span class="flag orange">TODO</span> Write usage instructions here, but first write the library...</p>
|
||
|
|
||
|
<h2>Roadmap</h2>
|
||
|
|
||
|
<ul><li>[ ] Apetite</li><li>[ ] Vector Math</li><li>[ ] Matrix</li><li>[ ] NDArray</li><li>[x] Vector</li><li>[ ] Line</li><li>[ ] Plane</li><li>[ ] Polygon</li><li>[ ] LinkedList
|
||
|
</li></ul>
|
||
|
|
||
|
<h2>Contributing</h2>
|
||
|
|
||
|
<ol><li>Fork it (<https://github.com/watzon/apatite/fork>)</li><li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li><li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li><li>Push to the branch (<code>git push origin my-new-feature</code>)</li><li>Create a new Pull Request</li></ol>
|
||
|
|
||
|
<h2>Contributors</h2>
|
||
|
|
||
|
<ul><li><a href="https://github.com/watzon" target="_blank">Chris Watson</a> - creator and maintainer</li></ul>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|