diff options
Diffstat (limited to 'docs/archive/install.html')
| -rw-r--r-- | docs/archive/install.html | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/docs/archive/install.html b/docs/archive/install.html new file mode 100644 index 0000000..a924fa8 --- /dev/null +++ b/docs/archive/install.html @@ -0,0 +1,238 @@ +<!DOCTYPE html> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta charset="utf-8"> + <meta name="generator" content="Docutils 0.22.4: https://docutils.sourceforge.io/"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta content="nixtamal, install" name="keywords"> + <meta content="knowledge about how to install Nixtamal" name="description"> + <meta content="" name="robots"> + <meta content="" name="author"> + <title> + Install | Nixtamal + </title> + <meta name="generator" content="soupault"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + <meta http-equiv="X-XSS-Protection" content="1;mode=block"> + <meta http-equiv="X-Content-Type-Options" content="nosniff"> + <meta http-equiv="Content-Security-Policy" content="default-src 'self';"> + <meta http-equiv="Referrer-Policy" content="strict-origin-when-cross-origin"> + <meta name="theme" content="crimson"> + <link rel="icon" type="image/svg+xml" href="/asset/_hashed/nixtamal/image/nixtamal-logo-gmxzsw8388sf9paq05xws7an4hnl4nx0.svg"> + <link rel="stylesheet" href="/asset/_hashed/nixtamal/style/font-j47xx20z5d89qpsl95nnbipkg6d25m6y.css"> + <link rel="stylesheet" href="/asset/_hashed/sugilite256/chroma-light-yfrfnk1zyqm9dc67gaa5y67s0a6x40ji.css"> + <link rel="stylesheet" href="/asset/_hashed/sugilite256/chroma-dark-s4ssx3zwz2w418zx7pkrqlwqmywgvahl.css" media="(prefers-color-scheme: dark)"> + <link rel="stylesheet" href="/asset/_hashed/nixtamal/style/main-lmdn1rci18371fnrcqrwga636ip08irz.css"> + <link rel="author" href="/humans.txt"> + </head> + <body class="with-toc"> + <div id="DocWrapper" class="DocWrapper"> + <div class="Banner-wrapper"> + <header id="Banner" class="Banner"> + <pre role="none" class="Banner-flair">âââ»+â» â±ââ³âââââ³ââââ» +ââââââââ¹ââ¹â£â«ââââ£â«â +â¹âââ¹â± â¹ â¹ â¹â¹â¹ â¹â¹â¹ââ</pre> + <a href="/" class="SiteLogo" title="Home"> + <svg viewbox="0 0 79.375 27.099415" class="SiteLogo-image" role="img" aria-labelledby="SiteLogo-desc"> + <use href="/asset/_hashed/nixtamal/image/nixtamal-logo-gmxzsw8388sf9paq05xws7an4hnl4nx0.svg#logo"> + <desc id="SiteLogo-desc"> + Home + </desc> + </use> + </svg> + </a> + <nav id="Navigation" class="Banner-navigation Navigation Navigation--banner" aria-expanded="true"> + <a class="Navigation-item" href="/install/">Install</a> + <a class="Navigation-item" href="/manpage/">Manpage</a> + <a class="Navigation-item" href="/changelog/">Changelog</a> + <a class="Navigation-item" href="/roadmap/">Roadmap</a> + <a class="Navigation-item" href="/cookbook/">Cookbook</a> + <a class="Navigation-item" href="/real-world-showcase/">Real-world showcase</a> + + <a class="Navigation-item" href="/community/">Community</a> + <a class="Navigation-item" href="/faqs/"><abbr title="frequently asked questions">FAQs</abbr></a> + <a class="Navigation-item" href="/funding/">Funding</a> + </nav> + </header> + <hr class="Banner-separator"> + </div> + <main id="Main" class="Main"> + <article id="Article" class="Article Stack"> + <header class="Headline Article-headline"> + <h1 itemprop="headline" class="title"> + Install + </h1> + </header> + <section itemprop="articleBody" id="Content" class="Content Article-body"> + <nav class="contents" id="table-of-contents" role="doc-toc"> + <p class="topic-title"> + <a class="reference internal" href="#top">Table of Contents</a> + </p> + <ul class="simple"> + <li> + <p> + <a class="reference internal" href="#from-nix-nixpkgs" id="toc-entry-1">From Nix + Nixpkgs</a> + </p> + </li> + <li> + <p> + <a class="reference internal" href="#from-source" id="toc-entry-2">From source</a> + </p> + </li> + <li> + <p> + <a class="reference internal" href="#add-overlay" id="toc-entry-3">Add overlay</a> + </p> + </li> + <li> + <p> + <a class="reference internal" href="#for-development-sending-patches-using-pre-release-next" id="toc-entry-4">For development & sending patches using pre-release @ next</a> + </p> + </li> + <li> + <p> + <a class="reference internal" href="#using-pre-release-in-manifest-kdl" id="toc-entry-5">Using pre-release in manifest.kdl</a> + </p> + </li> + </ul> + </nav> + <section id="from-nix-nixpkgs"> + <h2> + <a class="toc-backref" href="#toc-entry-1" role="doc-backlink">From Nix + Nixpkgs</a> + </h2> + <p> + If on NixOS unstable, you can run (but <a class="reference external" href="https://search.nixos.org/packages?channel=unstable&query=nixtamal">be wary of version</a>): + </p> + <pre class="code console literal-block"></pre> + <p> + Since the merge isnât propogated to a biannual NixOS release, this technically means if you have <code>extra-experimental-features = nix-command flakes</code>, you could try <code>nix run github:NixOS/nixpkgs?ref=nixos-unstable#nixtamal</code> for now. +Alternatively, if wanting to trial run one of the open pull requests, you can use <code>nix-run https://github.com/toastal/nixpkgs/archive/refs/heads/nixtamal-${VERSION}.zip -A nixtamal</code>. + </p> + </section> + <section id="from-source"> + <h2> + <a class="toc-backref" href="#toc-entry-2" role="doc-backlink">From source</a> + </h2> + <p> + If you donât have <abbr title="Darcs Advanced Revision Control System">Darcs</abbr> installed, you can use from Nixpkgs such as + </p> + <pre class="code console literal-block"></pre> + <p> + After/else clone from one of the mirrors + </p> + <pre class="code console literal-block"></pre> + <p> + Then change directory to the project & set up + </p> + <pre class="code console literal-block"></pre> + <p> + Now build! + </p> + <pre class="code console literal-block"></pre> + <p> + You can optionally install as Nix profile + </p> + <pre class="code console literal-block"></pre> + </section> + <section id="add-overlay"> + <h2> + <a class="toc-backref" href="#toc-entry-3" role="doc-backlink">Add overlay</a> + </h2> + <p> + With access to <code>nixtamal</code> (even if from <code>nixtamal/result/bin</code>), you can now bootstrap yourself to add the overlay to a system configuration + </p> + <pre class="code console literal-block"></pre> + <p> + With the <code>manifest.kdl</code> open + </p> + <pre class="code kdl literal-block"><span class="nl">inputs</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> nixtamal</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> darcs</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> repository</span><span class="w"> </span><span class="s">"https://darcs.toastal.in.th/nixtamal/stable"</span><span class="w"> +</span><span class="nl"> mirrors</span><span class="w"> </span><span class="s">"https://smeder.ee/~toastal/nixtamal.darcs"</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="nl"> fresh-cmd</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> $</span><span class="w"> </span><span class="s">curl</span><span class="w"> </span><span class="s">-sL</span><span class="w"> </span><span class="s">"https://darcs.toastal.in.th/nixtamal/stable/_darcs/weak_hash"</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="o">}</span></pre> + <p> + Which can can now be used for adding the overlay + </p> + <pre class="code nix literal-block"><span class="k">let</span> + <span class="c1"># imports the lockfile thru default.nix shim</span> + <span class="n">inputs</span> <span class="o">=</span> <span class="kn">import</span> <span class="sr">.nix/tamal</span> <span class="p">{</span> <span class="p">};</span> + + <span class="n">pkgs</span> <span class="o">=</span> <span class="kn">import</span> <span class="n">inputs</span><span class="o">.</span><span class="n">nixpkgs</span> <span class="p">{</span> + <span class="n">overlays</span> <span class="o">=</span> <span class="p">[</span> + <span class="c1"># apply our Nixtamal overlay to Nixpkgs</span> + <span class="p">(</span><span class="kn">import</span> <span class="s2">"</span><span class="si">${</span><span class="n">inputs</span><span class="o">.</span><span class="n">nixtamal</span><span class="si">}</span><span class="s2">/nix/overlay"</span><span class="p">)</span> + <span class="c1"># Nixtamal binary will be at pkgs.nixtamal.nixtamal</span> + <span class="p">];</span> + <span class="p">};</span> +<span class="k">in</span> +<span class="n">pkgs</span><span class="o">.</span><span class="n">nixtamal</span></pre> + </section> + <section id="for-development-sending-patches-using-pre-release-next"> + <h2> + <a class="toc-backref" href="#toc-entry-4" role="doc-backlink">For development & sending patches using pre-release @ next</a> + </h2> + <pre class="code console literal-block"></pre> + </section> + <section id="using-pre-release-in-manifest-kdl"> + <h2> + <a class="toc-backref" href="#toc-entry-5" role="doc-backlink">Using pre-release in manifest.kdl</a> + </h2> + <pre class="code kdl literal-block"><span class="nl">inputs</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> nixpkgs</span><span class="w"> </span><span class="o">{</span><span class="c1">// ⦠+</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="nl"> nixtamal</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> darcs</span><span class="w"> </span><span class="o">{</span><span class="w"> +</span><span class="w"> </span><span class="c1">// next isnât mirrored +</span><span class="nl"> repository</span><span class="w"> </span><span class="s">"https://darcs.toastal.in.th/nixtamal/next/"</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="nl"> fresh-cmd</span><span class="w"> </span><span class="o">{</span><span class="nl"> +</span><span class="nl"> $</span><span class="w"> </span><span class="s">curl</span><span class="w"> </span><span class="s">-sL</span><span class="w"> </span><span class="s">"https://darcs.toastal.in.th/nixtamal/next/_darcs/weak_hash"</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="w"> </span><span class="o">}</span><span class="w"> +</span><span class="o">}</span></pre> + </section> + </section> + </article> + </main> + <footer id="Footer" class="Footer"> + <p> + Site made with <a href="https://nixos.org">Nix</a> (<abbr title="dependency">dep</abbr> management), <a href="https://nickel-lang.org">Nickel</a> (<abbr title="configuration">config</abbr>), <a href="https://soupault.net">Soupault</a> (<abbr title="static site generator">SSG</abbr>), <a href="https://docutils.sourceforge.io">Docutils</a> (<abbr title="reStructuredText">rST</abbr> rendering), <a href="https://mandoc.bsd.lv">mandoc</a> (manpage conversion), & <a href="https://hub.darcs.net/toastal/sugilite256">sugilite256</a> (color scheme). + </p> + <small class="Footer-copyright"> + © 2025â2026 <span itemtype="https://schema.org/Person" itemscope=""><a itemprop="url" href="https://toast.al"><span itemprop="name">toastal</span></a></span>. + © 2026 Nixtamal contributors. + Some rights reserved. + Except where otherwise noted, the content on this website is licensed under <abbr title="Creative Commons Attribution Share Alike 4.0 International">CC-BY-SA-4.0</abbr>. + Citations must attribute the workâs writer/maker & include a hyperlink to this website (or rather the work itself). + Yes, these rules/clauses apply to <abbr title="large language models">LLM</abbr>s & <abbr title="artificial intellegence">AI</abbr> assistants too. + </small> + <div id="Maker" itemscope="" itemtype="https://schema.org/Person"> + <link itemprop="url" href="https://toast.al/"> + <meta itemprop="name" content="toastal"> + <meta itemprop="foundingDate" content="2025"> + <link itemprop="logo" href="https://nixtamal.toast.al/asset/_hashed/nixtamal/image/nixtamal-logo-gmxzsw8388sf9paq05xws7an4hnl4nx0.svg"> + <div itemprop="address" itemscope="" itemtype="https://schema.org/PostalAddress"> + <meta itemprop="addressCountry" content="TH"> + </div> + <link itemprop="sameAs" href="https://keybase.io/toastal"> + <link itemprop="sameAs" href="https://liberapay.com/toastal/"> + <link itemprop="sameAs" href="https://types.pl/@toastal"> + <link itemprop="sameAs" href="https://hub.darcs.net/toastal"> + <link itemprop="sameAs" href="https://smeder.ee/~toastal"> + <link itemprop="sameAs" href="https://nest.pijul.com/toastal"> + <link itemprop="sameAs" href="https://codeberg.org/toastal/"> + <link itemprop="sameAs" href="https://git.sr.ht/~toastal/"> + <link itemprop="sameAs" href="https://gitlab.com/toastal"> + <link itemprop="sameAs" href="https://github.com/toastal"> + </div> + </footer> + </div> +</body> +</html> |