Skip to content

Commit

Permalink
deploy: 0412c42
Browse files Browse the repository at this point in the history
  • Loading branch information
jespercockx committed Oct 1, 2024
1 parent c27ad3e commit 0b054f8
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
24 changes: 23 additions & 1 deletion _sources/introduction.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,29 @@
- you can navigate the library in [HTML format](https://agda.github.io/agda2hs/lib/),
along with a comprehensive [test suite](https://agda.github.io/agda2hs/test/)

### Installation
### Installation with Cabal

agda2hs is released [on Hackage](https://hackage.haskell.org/package/agda2hs),
and can be installed with Cabal:

```sh
cabal install agda2hs
```

Once installed, the agda2hs prelude bundled with agda2hs
can be registered in the Agda config using the `agda2hs locate` command:

```sh
agda2hs locate >> ~/.agda/libaries
```

Optionally, the agda2hs prelude can also be added as a default global import:

```sh
echo agda2hs >> ~/.agda/defaults
```

### Manual installation

Let `DIR` be the directory in which you start running these shell commands.
```sh
Expand Down
24 changes: 21 additions & 3 deletions introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l3"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#installation-with-cabal">Installation with Cabal</a></li>
<li class="toctree-l3"><a class="reference internal" href="#manual-installation">Manual installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#running-agda2hs">Running <code class="docutils literal notranslate"><span class="pre">agda2hs</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-agda2hs-with-stack">Using agda2hs with Stack</a></li>
</ul>
Expand Down Expand Up @@ -107,8 +108,25 @@ <h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
</li>
</ul>
</section>
<section id="installation">
<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h3>
<section id="installation-with-cabal">
<h3>Installation with Cabal<a class="headerlink" href="#installation-with-cabal" title="Permalink to this heading"></a></h3>
<p>agda2hs is released <a class="reference external" href="https://hackage.haskell.org/package/agda2hs">on Hackage</a>,
and can be installed with Cabal:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cabal<span class="w"> </span>install<span class="w"> </span>agda2hs
</pre></div>
</div>
<p>Once installed, the agda2hs prelude bundled with agda2hs
can be registered in the Agda config using the <code class="docutils literal notranslate"><span class="pre">agda2hs</span> <span class="pre">locate</span></code> command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>agda2hs<span class="w"> </span>locate<span class="w"> </span>&gt;&gt;<span class="w"> </span>~/.agda/libaries
</pre></div>
</div>
<p>Optionally, the agda2hs prelude can also be added as a default global import:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span>agda2hs<span class="w"> </span>&gt;&gt;<span class="w"> </span>~/.agda/defaults
</pre></div>
</div>
</section>
<section id="manual-installation">
<h3>Manual installation<a class="headerlink" href="#manual-installation" title="Permalink to this heading"></a></h3>
<p>Let <code class="docutils literal notranslate"><span class="pre">DIR</span></code> be the directory in which you start running these shell commands.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># clone the repository locally</span>
git<span class="w"> </span>clone<span class="w"> </span>[email protected]:agda/agda2hs.git
Expand Down
Loading

0 comments on commit 0b054f8

Please sign in to comment.