docs/manual/install.org

 1#+TITLE: Install
 2#+DESCRIPTION: Building Orgstar for the Mac and the iOS Simulator from source.
 3#+LEDE: Orgstar is built from source; there are no prebuilt downloads yet.
 4
 5* Requirements
 6
 7- macOS 26 or later.
 8- Xcode 27 (the Swift 6.2 toolchain).
 9- Optional: GNU Emacs, for the features that hand work to it on the Mac
10  (Emacs Lisp code blocks that need full Emacs, Lisp table formulas the built-in
11  interpreter can't run, and export to PDF, LaTeX, ODT and other formats). See
12  [[file:guide/15-alongside-emacs.org][Working alongside Emacs and other tools]].
13
14* The Mac app
15
16#+BEGIN_SRC sh
17git clone https://gitbay.org/krz/orgstar.git
18cd orgstar
19scripts/build-app.sh
20open .build/app/Orgstar.app
21#+END_SRC
22
23=scripts/build-app.sh= builds a release binary and assembles
24=.build/app/Orgstar.app= with its Quick Look and Spotlight extensions, signed ad hoc
25for use on your own Mac. Move it to =/Applications= to keep it. Pass a version number
26as the first argument to stamp the bundle (=scripts/build-app.sh 1.0.0=); the default
27is =0.1.0=.
28
29Once the app has been launched, Finder opens =.org= files with it, Quick Look shows
30them formatted, and Spotlight indexes their headings and text.
31
32* The iOS app
33
34The iOS app (iOS 26 or later) is built with Xcode from =ios/Orgstar.xcodeproj=:
35
361. Open =ios/Orgstar.xcodeproj=.
372. Select the *Orgstar iOS* target, then Signing & Capabilities, and choose your team.
38   Change the bundle identifiers (=sh.krz.orgstar= and the two extensions' =.share= and
39   =.quicklook=) and the App Group (=group.sh.krz.orgstar=) to ones your team can register.
403. Choose your iPhone or iPad (or a Simulator) as the destination and Run (=⌘R=).
41
42On a device, Developer Mode must be on (Settings ▸ Privacy & Security ▸ Developer Mode).
43
44For the Simulator without opening Xcode:
45
46#+BEGIN_SRC sh
47scripts/build-ios-app.sh
48xcrun simctl install booted .build/ios-app/Orgstar.app
49#+END_SRC
50
51See [[file:guide/14-ios.org][iPhone and iPad]] for what it does.
52
53* Updating
54
55Pull and build again:
56
57#+BEGIN_SRC sh
58git pull
59scripts/build-app.sh
60#+END_SRC
61
62Your settings live in =~/.config/orgstar/= and survive rebuilds.
63
64* Uninstalling
65
66Delete =Orgstar.app=. To remove your settings as well, delete =~/.config/orgstar/=.
67Your org files are never stored inside the app.