Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
89 lines (73 sloc) 4.63 KB
<!DOCTYPE html>
<html lang="en">
<head>
<title>Install Serulian</title>
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css" integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">
<link rel="stylesheet" href="/playground.css">
<link rel="stylesheet" href="/content.css">
<link href="https://fonts.googleapis.com/css?family=Inconsolata" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Fira+Sans" rel="stylesheet">
<style type="text/css">
h2 {
margin-top: 60px;
}
h3 {
margin-top: 20px;
}
h2 img, h3 img {
height: 2em;
margin-right: 10px;
}
.install-section {
padding: 1em;
padding-left: 2em;
}
</style>
</head>
<body>
<!-- From: http://tholman.com/github-corners/ -->
<a href="https://github.com/serulian/playground/tree/master/static/install.html" class="github-corner" aria-label="View source on Github"><svg width="60" height="60" viewBox="0 0 250 250" style="fill:#2061a4; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
<header>
<a href="/" class="language-title">Serulian</a>
<a href="/gettingstarted">Getting Started</a>
<a href="/guide">Guide</a>
<a class="active-section" href="/install">Install</a>
<a href="https://medium.com/@serulian">Blog</a>
<a href="https://github.com/serulian/compiler">File an issue</a>
</header>
<div class="container">
<div class="row">
<div class="col-md-12">
<h2>Serulian Installation</h2>
<h3><img src="/homebrew.png">Homebrew</h3>
<div class="install-section">
<p>On OS X, Serulian can be installed using a <a href="https://brew.sh/" target="_blank">Homebrew</a> tap formula:</p>
<pre class="sh">brew tap serulian/serulian &amp;&amp; brew install serulian</pre>
</div>
<h3><img src="/docker.png">Docker</h3>
<div class="install-section">
<p>Serulian can be run via Docker by pulling the following image:</p>
<pre class="sh">docker pull quay.io/serulian/compiler:latest</pre>
<p>The toolkit can then be used by mounting the source directory into the container when it is run:</p>
<pre class="sh">docker run -ti -v path/to/source/directory:/src/ quay.io/serulian/compiler:latest build /src/somefile.seru</pre>
<p>The compiled result will be placed into the same mounted directory.</p>
</div>
<h3><img src="/gopher.png">Go source</h3>
<div class="install-section">
<p>To install Serulian from source, use via the <code>go get</code> command:</p>
<pre class="sh">go get -t github.com/serulian/compiler/cmd/serulian</pre>
<p>Once complete, the <code>serulian</code> binary will be accessible under <code>$GOPATH/bin</code>:</p>
<pre class="sh">serulian build myentrypoint.seru</pre>
</div>
<h2><img src="/vscode.png">Visual Studio Code Extension</h2>
<div class="install-section">
Serulian publishes <a href="https://marketplace.visualstudio.com/items?itemName=serulian.serulian">an extension for Visual Studio Code</a>, which allows for full IDE tooling,
including syntax highlighting, autocompletion, and more.
</div>
</div>
</div>
</div>
</body>
</html>
You can’t perform that action at this time.