mirror of https://github.com/perkeep/perkeep.git
31 lines
1.2 KiB
HTML
31 lines
1.2 KiB
HTML
<h1>Documentation</h1>
|
|
|
|
<p>The documentation is mostly in the project's <a href="/gw/doc">doc/
|
|
directory</a> or in the source itself. It's now being promoted to
|
|
HTML, though:</p>
|
|
|
|
<h2>Overview</h2>
|
|
|
|
<ul>
|
|
<li><a href="/docs/arch">Architecture</a>: the pieces, layers, and how they interact</li>
|
|
<li><a href="/docs/principles">Principles</a>: our base principles, goals, assumptions</li>
|
|
<li><a href="/docs/terms">Terminology</a>: let's agree on terms to stay sane</li>
|
|
<li><a href="/docs/schema">Schema</a>: how we model data in Camlistore</li>
|
|
<li><a href="/docs/json-signing">JSON Signing</a></li>
|
|
<li><a href="/docs/uses">Use Cases</a>: what one might do with all this (or at least our aspirations)</li>
|
|
<li><a href="/docs/sharing">Sharing</a></li>
|
|
<li><a href="/docs/prior-art">Prior Art</a>: other projects doing similar stuff</li>
|
|
<li><a href="/docs/status">Project Status</a>: where we're at</li>
|
|
<li><a href="/docs/contributing">Contributing</a>: how to help</li>
|
|
</ul>
|
|
|
|
<h2>Commands</h2>
|
|
|
|
<ul>
|
|
<li><a href="/cmd/camput">camput</a>: add <a href="/docs/schema">files & other blobs & objects</a> to one of your camli blob servers</a></li>
|
|
<li><a href="/cmd/camget">camget</a>: (less mature) fetch things from a blob server</li>
|
|
|
|
</ul>
|
|
|
|
|