diff options
| author | Fuwn <[email protected]> | 2022-02-07 12:39:46 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2022-02-07 12:39:46 +0000 |
| commit | 9ebc1e2e7694487b840dc70f6b8c908e4b4c78c6 (patch) | |
| tree | b2d4b06d1d4bca53be8281aed770f2beae89d23c | |
| parent | Deploying to gh-pages from @ divinaland/documentation@4d9bae3f502d32f0840b513... (diff) | |
| download | documentation-9ebc1e2e7694487b840dc70f6b8c908e4b4c78c6.tar.xz documentation-9ebc1e2e7694487b840dc70f6b8c908e4b4c78c6.zip | |
Deploying to gh-pages from @ divinaland/documentation@4fc0c1278b0a79ce01e8446833bc0ce33493dbec 🚀
| -rw-r--r-- | about.html | 4 | ||||
| -rw-r--r-- | index.html | 4 | ||||
| -rw-r--r-- | manifest-format.html | 120 | ||||
| -rw-r--r-- | manifest-format/examples.html | 53 |
4 files changed, 181 insertions, 0 deletions
@@ -28,6 +28,10 @@ </label> <ul> <li><a href="index.html">Home</a></li> +<li><a href="manifest-format.html">Manifest Format</a><ul> +<li><a href="manifest-format/examples.html">Examples</a></li> +</ul> +</li> <li><a href="about.html">About</a></li> <li><a href="https://github.com/divinaland/Divina">GitHub</a></li> </ul> @@ -30,6 +30,10 @@ </label> <ul> <li><a href="index.html">Home</a></li> +<li><a href="manifest-format.html">Manifest Format</a><ul> +<li><a href="manifest-format/examples.html">Examples</a></li> +</ul> +</li> <li><a href="about.html">About</a></li> <li><a href="https://github.com/divinaland/Divina">GitHub</a></li> </ul> diff --git a/manifest-format.html b/manifest-format.html new file mode 100644 index 0000000..0fb42ad --- /dev/null +++ b/manifest-format.html @@ -0,0 +1,120 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>Manifest Format — Divina</title> + <link rel="stylesheet" href="assets/fonts.css"> + <link rel="stylesheet" href="assets/graphite.css"> + <link rel="stylesheet" href="assets/pygments.css"> + + + </head> + <body class="node-manifest-format node"> + <header class="masthead"> + <h1><a href="index.html">Divina</a></h1> + + <p class="tagline">🎀 A modern build system for assembly</p> + + + <p class="version">Version 0.1.0</p> + + <nav class="menu"> + <input id="menu-check" type="checkbox"/> + <label id="menu-label" for="menu-check" class="unselectable"> + <span class="icon close-icon">✕</span> + <span class="icon open-icon">☰</span> + <span class="text">Menu</span> + </label> + <ul> +<li><a href="index.html">Home</a></li> +<li><a href="manifest-format.html">Manifest Format</a><ul> +<li><a href="manifest-format/examples.html">Examples</a></li> +</ul> +</li> +<li><a href="about.html">About</a></li> +<li><a href="https://github.com/divinaland/Divina">GitHub</a></li> +</ul> + </nav> + </header> + <article class="main"> + <header class="title"> + <h1>Manifest Format — Divina</h1> + + <hr> + </header> + <h2 id="rules"> +Rules +</h2> +<ul> +<li> +All Divina manifests must be named <code>Divina.lua</code> +</li> +<li> +Package manifests should be in a subdirectory +</li> +<li> +A workspace manifest can only source package manifests +</li> +</ul> +<h2 id="divina-exposed-globals"> +Divina Exposed Globals +</h2> +<pre class="lang-lua pygments" data-lang="lua"> +<span class="c1">--- @class Divina</span> +<span class="c1">--- @field public version string Installed Divina version</span> +<span class="c1">--- @field public Type table<string, number> Package type</span> +<span class="c1">--- @field public Arch table<string, number> Architecture to compile for</span> +<span class="n">Divina</span> <span class="o">=</span> <span class="p">{</span> + <span class="n">version</span><span class="p">,</span> + <span class="n">Type</span> <span class="o">=</span> <span class="p">{</span> + <span class="n">Bin</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> + <span class="n">Lib</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> + <span class="p">},</span> + <span class="n">Arch</span> <span class="o">=</span> <span class="p">{</span> + <span class="n">x86</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> + <span class="n">x64</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> + <span class="p">},</span> +<span class="p">}</span> + +<span class="c1">--- @return void</span> +<span class="kr">function</span> <span class="nf">test</span><span class="p">()</span> <span class="kr">end</span> +</pre> +<h2 id="workspace-manifest-format"> +Workspace Manifest Format +</h2> +<pre class="lang-lua pygments" data-lang="lua"> +<span class="c1">--- @class Workspace</span> +<span class="c1">--- @field public members string[]</span> +<span class="n">Workspace</span> <span class="o">=</span> <span class="p">{</span> + <span class="n">members</span><span class="p">,</span> +<span class="p">}</span> +</pre> +<h2 id="package-manifest-format"> +Package Manifest Format +</h2> +<pre class="lang-lua pygments" data-lang="lua"> +<span class="c1">--- @class Package</span> +<span class="c1">--- @field public name string</span> +<span class="c1">--- @field public version string</span> +<span class="c1">--- @field public description string</span> +<span class="c1">--- @field public compile_options string[]</span> +<span class="c1">--- @field public minimum_divina_version string</span> +<span class="c1">--- @field public sources string[]</span> +<span class="c1">--- @field public compiler string</span> +<span class="n">Package</span> <span class="o">=</span> <span class="p">{</span> + <span class="n">name</span><span class="p">,</span> + <span class="n">version</span><span class="p">,</span> + <span class="n">description</span><span class="p">,</span> + <span class="n">compile_options</span><span class="p">,</span> + <span class="n">minimum_divina_version</span><span class="p">,</span> + <span class="n">sources</span><span class="p">,</span> + <span class="nb">type</span><span class="p">,</span> + <span class="n">arch</span><span class="p">,</span> + <span class="n">compiler</span><span class="p">,</span> +<span class="p">}</span> +</pre> + </article> + + </body> +</html> diff --git a/manifest-format/examples.html b/manifest-format/examples.html new file mode 100644 index 0000000..a9492b1 --- /dev/null +++ b/manifest-format/examples.html @@ -0,0 +1,53 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>Manifest Format — Examples — Divina</title> + <link rel="stylesheet" href="../assets/fonts.css"> + <link rel="stylesheet" href="../assets/graphite.css"> + <link rel="stylesheet" href="../assets/pygments.css"> + + + </head> + <body class="node-manifest-format-examples node-manifest-format node"> + <header class="masthead"> + <h1><a href="../index.html">Divina</a></h1> + + <p class="tagline">🎀 A modern build system for assembly</p> + + + <p class="version">Version 0.1.0</p> + + <nav class="menu"> + <input id="menu-check" type="checkbox"/> + <label id="menu-label" for="menu-check" class="unselectable"> + <span class="icon close-icon">✕</span> + <span class="icon open-icon">☰</span> + <span class="text">Menu</span> + </label> + <ul> +<li><a href="../index.html">Home</a></li> +<li><a href="../manifest-format.html">Manifest Format</a><ul> +<li><a href="../manifest-format/examples.html">Examples</a></li> +</ul> +</li> +<li><a href="../about.html">About</a></li> +<li><a href="https://github.com/divinaland/Divina">GitHub</a></li> +</ul> + </nav> + </header> + <article class="main"> + <header class="title"> + <h1>Manifest Format — Examples — Divina</h1> + + <hr> + </header> + <p>Examples for package manifests can be found within the Divina root repository +<a href="https://github.com/divinaland/Divina/tree/main/examples"><code>examples</code></a> directory, +and an example for a workspace manifest can be found within the root Divina repository, named +<a href="https://github.com/divinaland/Divina/blob/main/Divina.lua"><code>Divina.lua</code></a>.</p> + </article> + + </body> +</html> |