v0.23.0: Routine, first public version
This commit is contained in:
@@ -0,0 +1,82 @@
|
||||
# Building Routine.dmg on a Mac (once, for everyone)
|
||||
|
||||
`install-mac.sh` is the way to install Routine on a Mac today: one line in Terminal. A `.dmg` you
|
||||
open and drag to Applications is friendlier, but it has to be built on a Mac, and nobody has run
|
||||
the build yet. If you have a Mac, this is how to build it once and send it back, so it can be put
|
||||
up for download. **Untested so far**: if any step fails, send the whole Terminal output.
|
||||
|
||||
## What you need
|
||||
|
||||
- macOS 13 (Ventura) or newer. The app you build runs on the same kind of Mac as yours: on an
|
||||
Apple-silicon Mac (M1 and later) you build the Apple-silicon version; on an Intel Mac, the
|
||||
Intel one. (Both are welcome.)
|
||||
- About 2 GB of free space and an internet connection. No Xcode, Homebrew or admin password.
|
||||
|
||||
## Build it
|
||||
|
||||
In Terminal (⌘ Space, type `Terminal`):
|
||||
|
||||
```
|
||||
cd ~/Downloads
|
||||
curl -fsSL https://git.autonomic.zone/trav/routine/archive/main.tar.gz | tar -xzf -
|
||||
cd routine
|
||||
scripts/build-mac-app.sh
|
||||
```
|
||||
|
||||
It downloads uv, a Python and the packages into `build/mac/` (nothing outside this folder),
|
||||
freezes the app with PyInstaller, signs it ad hoc and makes the disk image. At the end it prints
|
||||
|
||||
```
|
||||
Done: …/routine/dist/Routine-<version>.dmg (… MB), for arm64 Macs.
|
||||
```
|
||||
|
||||
## Check it, then send it
|
||||
|
||||
1. Open `dist/Routine-<version>.dmg`: a window shows **Routine** and an **Applications** folder.
|
||||
2. Drag Routine onto Applications, eject the disk image, open Routine from Launchpad.
|
||||
3. Walk through `docs/mac-testing.md` from step 2 (skip step 1's install line, and in step 9
|
||||
remove it by dragging Routine from Applications to the Bin).
|
||||
4. Send `dist/Routine-<version>.dmg` (it's too big for most email: a file-sharing link is fine),
|
||||
with the last lines the build printed and your macOS version and chip.
|
||||
|
||||
To start over: delete `build/` and `dist/` and run the script again.
|
||||
|
||||
## What people see when they open it: Gatekeeper
|
||||
|
||||
The app is signed "ad hoc" (`codesign -s -`), not with an Apple Developer ID, and it isn't
|
||||
notarized by Apple (that needs a paid developer account). So the first time someone opens a copy
|
||||
they **downloaded**, macOS stops it. It only happens once per copy.
|
||||
|
||||
**macOS 15 Sequoia and newer**:
|
||||
|
||||
1. Double-clicking says **"Routine" Not Opened: Apple could not verify "Routine" is free of malware
|
||||
that may harm your Mac or compromise your privacy.** Click **Done** (not Move to Bin).
|
||||
2. Open **System Settings → Privacy & Security**, scroll down to **Security**: it says
|
||||
*"Routine" was blocked to protect your Mac.* Click **Open Anyway**, then enter your password.
|
||||
3. Open Routine again and click **Open Anyway** in the box that appears. From then on it opens
|
||||
normally.
|
||||
|
||||
**macOS 13 Ventura and 14 Sonoma**: right-click (or Control-click) Routine in Applications →
|
||||
**Open**, then **Open** in the box that appears. (Or the System Settings route above.)
|
||||
|
||||
**In Terminal, any version** (for people comfortable with it): after dragging it to Applications,
|
||||
|
||||
```
|
||||
xattr -dr com.apple.quarantine /Applications/Routine.app
|
||||
```
|
||||
|
||||
and it opens without the warning.
|
||||
|
||||
The one-line installer (`install-mac.sh`) doesn't hit any of this: it builds the app on the Mac
|
||||
itself, and nothing it downloads is marked as "from the internet".
|
||||
|
||||
## Notes for whoever maintains this
|
||||
|
||||
- The script pins uv, Python 3.13, PySide6-Essentials and PyInstaller (`scripts/build-mac-app.sh`).
|
||||
PySide6-Essentials has no Qt Multimedia, so sounds play through macOS's own `afplay`.
|
||||
- The data the app keeps is outside the bundle (`~/Library/Application Support/Routine`), so the
|
||||
.dmg app and the installer's app can replace each other freely.
|
||||
- Real signing + notarization later: a Developer ID certificate in place of `-`, then
|
||||
`xcrun notarytool submit … --wait` and `xcrun stapler staple` on the .dmg.
|
||||
- The freezing part was tried on Linux (`BUILD_TEST=1`: it builds and runs); the `.app`,
|
||||
`plutil`, `codesign` and `hdiutil` steps have never run.
|
||||
@@ -0,0 +1,106 @@
|
||||
# Trying Routine on a Mac: a checklist
|
||||
|
||||
Thank you for trying it! Routine has never run on a real Mac before, so every answer helps, "it
|
||||
worked" included. It takes about 20 minutes, most of it the download. Nothing here touches anything
|
||||
else on your Mac, and step 9 removes it all again if you like.
|
||||
|
||||
You need macOS 13 (Ventura) or newer: Apple menu → About This Mac. Write down the macOS version and
|
||||
whether it says "Chip: Apple M…" or "Processor: Intel…".
|
||||
|
||||
For each step, note **yes / no**, and for any "no", what you saw (a screenshot is perfect: ⇧⌘4,
|
||||
then drag over it; it lands on the Desktop).
|
||||
|
||||
## 1. Install
|
||||
|
||||
1. Open **Terminal** (⌘ Space, type `Terminal`, Return).
|
||||
2. Paste this line and press Return:
|
||||
|
||||
```
|
||||
curl -fsSL https://git.autonomic.zone/trav/routine/raw/branch/main/install-mac.sh | bash
|
||||
```
|
||||
|
||||
3. Wait until it says **Routine … is installed**. It downloads about 400 MB.
|
||||
|
||||
- [ ] It finished without an error. (If not: copy everything in the Terminal window, ⌘A then ⌘C,
|
||||
and paste it into your message.)
|
||||
- [ ] Did macOS ask you anything while it ran (a password, "allow access", a developer tools
|
||||
install)? It shouldn't. If it did, what exactly?
|
||||
|
||||
## 2. Open it
|
||||
|
||||
1. Open **Launchpad** (or ⌘ Space, type `Routine`) and click **Routine**.
|
||||
|
||||
- [ ] It opened, the first time. (If macOS said it "can't be opened" or "can't be checked for
|
||||
malicious software", say so, word for word.)
|
||||
- [ ] The icon in Launchpad and in the Dock is a ticked box with a few sparks, not a blank page
|
||||
or a rocket.
|
||||
- [ ] The menu bar at the top of the screen says **Routine** next to the Apple, not "Python".
|
||||
- [ ] Hover over its Dock icon: it says **Routine**.
|
||||
- [ ] There's only one Routine icon in the Dock (not one Routine and one Python).
|
||||
|
||||
## 3. The window
|
||||
|
||||
- [ ] The window has the normal Mac title bar with the red / yellow / green buttons.
|
||||
- [ ] You can move it by its title bar and resize it from its edges and corners.
|
||||
- [ ] The date at the top is in a clean, geometric font (not Times or a typewriter font), and the
|
||||
task names are easy to read.
|
||||
- [ ] The word **notes** above the box at the bottom is handwritten-looking.
|
||||
- [ ] Nothing looks blurry (text, boxes, the » button).
|
||||
- [ ] Turn your Mac to Dark mode (System Settings → Appearance → Dark): Routine turns dark too
|
||||
(maybe after reopening it). Back to Light afterwards if you like.
|
||||
|
||||
## 4. Ticking
|
||||
|
||||
1. Tick a few tasks.
|
||||
|
||||
- [ ] A little animation plays from the box, **with a sound**. (Volume up! Each tick has its own.)
|
||||
- [ ] Tick 6 or more: still animations and sounds.
|
||||
- [ ] Untick one in **All** (bottom left), and click **skip** on another: both work.
|
||||
- [ ] Write something in the box at the bottom, click a task, quit Routine (⌘Q), open it again:
|
||||
the note is still there.
|
||||
|
||||
## 5. Moving around
|
||||
|
||||
- [ ] Two-finger swipe sideways on the trackpad (or ‹ ›): earlier days. » brings you back to now.
|
||||
- [ ] Scrolling up and down the list is smooth.
|
||||
- [ ] Click a block's heading (e.g. **Morning**): its tasks hide; click again: back.
|
||||
|
||||
## 6. The menus and shortcuts
|
||||
|
||||
- [ ] **Routine** menu (top left, next to the Apple) has **About Routine**, **Settings…** (⌘,) and
|
||||
**Quit Routine** (⌘Q). All three work.
|
||||
- [ ] **View → History** (⌘Y), **Statistics** (⌘T) and **Journal** (⌘J) each open a window.
|
||||
- [ ] ⌘H hides Routine (as in any Mac app).
|
||||
- [ ] **Help → Open log folder** opens a Finder window (it may be empty: that's good).
|
||||
|
||||
## 7. History, Statistics, Journal
|
||||
|
||||
1. Open **View → History**.
|
||||
|
||||
- [ ] Pinch on the trackpad: it zooms in and out around your fingers. ⌘ + scroll does too.
|
||||
- [ ] Hover a dot: a tip says which task and day.
|
||||
- [ ] **Statistics** and **Journal** show your ticks and today's note.
|
||||
|
||||
## 8. Settings
|
||||
|
||||
1. Open Settings (⌘,).
|
||||
|
||||
- [ ] **Routine**: add a task to a block, **Save routine**: it shows up in the main window.
|
||||
- [ ] **Appearance**: drag a gray slider: the window changes colour as you drag.
|
||||
- [ ] **Data**: shows two paths under `…/Library/Application Support/Routine`.
|
||||
- [ ] **Sync** and **Rabbit R1** say **Coming soon on macOS.** and are greyed out.
|
||||
|
||||
## 9. Update and remove (optional)
|
||||
|
||||
- [ ] Run the install line from step 1 again: it finishes, Routine opens with your ticks and
|
||||
routine still there.
|
||||
- [ ] To remove it: paste
|
||||
`curl -fsSL https://git.autonomic.zone/trav/routine/raw/branch/main/install-mac.sh | bash -s -- --uninstall`.
|
||||
Routine is gone from Applications. (Your ticks stay in
|
||||
`~/Library/Application Support/Routine` unless you delete that folder.)
|
||||
|
||||
## Sending it back
|
||||
|
||||
Your yes / no list, the macOS version and chip, and any screenshots. If anything went wrong, also
|
||||
the files in **Help → Open log folder** (`errors.log`, `crash.log`, `launch.log`): they hold only
|
||||
where the program went wrong, never your tasks or notes.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 98 KiB |
Reference in New Issue
Block a user