install.html

 1<!DOCTYPE html>
 2<html lang="en">
 3<head>
 4<meta charset="utf-8">
 5<meta name="viewport" content="width=device-width, initial-scale=1">
 6<title>Install &middot; Orgstar</title>
 7<meta name="description" content="Building Orgstar for the Mac and the iOS Simulator from source.">
 8<link rel="icon" href="favicon.svg" type="image/svg+xml">
 9<link rel="stylesheet" href="theme.css">
10<link rel="stylesheet" href="syntax.css">
11<link rel="stylesheet" href="style.css">
12</head>
13<body>
14<header class="site">
15<a class="site-title" href="index.html">Orgstar</a>
16<nav>
17<a href="#">Install</a>
18<a href="quickstart.html">Quick start</a>
19<a href="guide/index.html">Manual</a>
20</nav>
21</header>
22<main>
23<h1>Install</h1>
24<p class="lede">Orgstar is built from source; there are no prebuilt downloads yet.</p>
25<nav class="toc" aria-label="On this page">
26<h2>On this page</h2>
27<ul>
28<li><a href="#requirements">Requirements</a></li>
29<li><a href="#the-mac-app">The Mac app</a></li>
30<li><a href="#the-ios-app">The iOS app</a></li>
31<li><a href="#updating">Updating</a></li>
32<li><a href="#uninstalling">Uninstalling</a></li>
33</ul>
34</nav>
35<h2 id="requirements">Requirements</h2>
36<ul>
37<li>macOS 26 or later.</li>
38<li>Xcode 27 (the Swift 6.2 toolchain).</li>
39<li>Optional: GNU Emacs, for the features that hand work to it on the Mac (Emacs Lisp code blocks that need full Emacs, Lisp table formulas the built-in interpreter can't run, and export to PDF, LaTeX, ODT and other formats). See <a href="guide/15-alongside-emacs.html">Working alongside Emacs and other tools</a>.</li>
40</ul>
41<h2 id="the-mac-app">The Mac app</h2>
42<pre><code class="language-sh highlight"><span class="source shell bash"><span class="meta function-call shell"><span class="variable function shell">git</span></span><span class="meta function-call arguments shell"> clone https://gitbay.org/krz/orgstar.git</span>
43<span class="meta function-call shell"><span class="support function cd shell">cd</span></span><span class="meta function-call arguments shell"> orgstar</span>
44<span class="meta function-call shell"><span class="variable function shell">scripts/build-app.sh</span></span>
45<span class="meta function-call shell"><span class="variable function shell">open</span></span><span class="meta function-call arguments shell"> .build/app/Orgstar.app</span></span></code></pre>
46<p><code class="verbatim">scripts/build-app.sh</code> builds a release binary and assembles <code class="verbatim">.build/app/Orgstar.app</code> with its Quick Look and Spotlight extensions, signed ad hoc for use on your own Mac. Move it to <code class="verbatim">/Applications</code> to keep it. Pass a version number as the first argument to stamp the bundle (<code class="verbatim">scripts/build-app.sh 1.0.0</code>); the default is <code class="verbatim">0.1.0</code>.</p>
47<p>Once the app has been launched, Finder opens <code class="verbatim">.org</code> files with it, Quick Look shows them formatted, and Spotlight indexes their headings and text.</p>
48<h2 id="the-ios-app">The iOS app</h2>
49<p>The iOS app (iOS 26 or later) currently builds for the Simulator:</p>
50<pre><code class="language-sh highlight"><span class="source shell bash"><span class="meta function-call shell"><span class="variable function shell">scripts/build-ios-app.sh</span></span>
51<span class="meta function-call shell"><span class="variable function shell">xcrun</span></span><span class="meta function-call arguments shell"> simctl install booted .build/ios-app/Orgstar.app</span></span></code></pre>
52<p>See <a href="guide/14-ios.html">iPhone and iPad</a> for what it does.</p>
53<h2 id="updating">Updating</h2>
54<p>Pull and build again:</p>
55<pre><code class="language-sh highlight"><span class="source shell bash"><span class="meta function-call shell"><span class="variable function shell">git</span></span><span class="meta function-call arguments shell"> pull</span>
56<span class="meta function-call shell"><span class="variable function shell">scripts/build-app.sh</span></span></span></code></pre>
57<p>Your settings live in <code class="verbatim">~/.config/orgstar/</code> and survive rebuilds.</p>
58<h2 id="uninstalling">Uninstalling</h2>
59<p>Delete <code class="verbatim">Orgstar.app</code>. To remove your settings as well, delete <code class="verbatim">~/.config/orgstar/</code>. Your org files are never stored inside the app.</p>
60</main>
61<footer class="site">
62Orgstar is 0BSD-licensed. Source: <a href="https://gitbay.org/krz/orgstar">gitbay.org/krz/orgstar</a>.
63</footer>
64</body>
65</html>