Skip to content

Commit

Permalink
Update README and TODO
Browse files Browse the repository at this point in the history
  • Loading branch information
rxhfcy committed Apr 6, 2024
1 parent c9cf17a commit bd05e62
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 18 deletions.
34 changes: 26 additions & 8 deletions Asahi Linux Helper/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@
- **"3:" - Could have.** Desirable but not crucial, included if resources allow.
- **"4:" - Won't have.** Lowest priority, currently not planned.

## TODO items (please keep the list up-to-date):
## TODO items
(please keep this TODO list up-to-date)

- [ ] (todo: add link to Linux version's TODO list)

# (NOTE: if you tweak something, please keep macOS/Linux TODOs synced!)

- [ ] 1: Redo screenshots
- make menubar look as normal as possible
- show digital clock etc
- easter egg: show a funny time
- stereotypical wallpaper
- don't make mini screenshot any more tightly cropped, make menubar look "normal" and recognizable as a menubar at a glance? Test/compare?

- [ ] 2: Make popover close/hide after user clicks "Restart..." and modal password dialog appears
- must block all other UI interactions with the app while the dialog is active
Expand Down Expand Up @@ -86,6 +98,7 @@
- "Asahi Linux Helper"?

- [ ] 2: GitHub blurb ok?
- Compare with Linux version
- "Asahi Linux Helper: macOS menubar app to easily Restart in Linux (btw add other Asahi Linux tools later?)"
- "Asahi Restart Helper: Restart to Asahi Linux this time only (macOS menubar app)"
- "Asahi Restart Helper makes it easy to choose which OS / disk will be used to restart
Expand All @@ -99,6 +112,7 @@

- [ ] 2: Scope creep? What should the project (not) do?
- Should name be just "Asahi Restart Helper" instead? Does the Asahi project want a more general "helper"?
- note that Linux version can offer much less functionality for technical reasons
- potential future "helper" functionality: update m1n1 bootloader
- potential future "helper" functionality: run Asahi installer
- potential future "helper" functionality (stretch goal): uninstall Asahi Linux
Expand Down Expand Up @@ -128,6 +142,10 @@
- reason: if release version is (accidentally?) built Universal, it will not show an error by default
- reason why not: corner case (doesn't work, and pointless on Intel: Asahi Linux requires Apple Silicon)

- [ ] 3: Show something (Open the menu? Open preferences?) if user launches from Finder while app was already running
- reason: maybe user is confused and doesn't notice the menubar icon?
- reason why not: corner case, adds code complexity

- [ ] 3: Auto updater
- use someone else's solution as reference?
- if super simple, DIY?
Expand Down Expand Up @@ -174,10 +192,6 @@
- justify text like in system dialog?
- reason why not: current dialog is simple and does the job (impossible to add the "official" checkbox etc)

- [ ] 4: Show something (Open the menu? Open preferences?) if user launches from Finder while app was already running
- reason: maybe user is confused and doesn't notice the menubar icon?
- reason why not: corner case, adds code complexity

- [ ] 4: If prefs not enabled, try to convince user to enable pref?
- show button/checkbox in the main "Restart dialog"?
- don't be deceptive or potentially destructive, users might thinks it's the "normal restart toggle"
Expand All @@ -202,8 +216,9 @@
- reason why not: already tried to "fix", fixing seems difficult and error-prone

- [ ] 4: (I DON'T LIKE THIS) Ask user for "Linux" disk and only show that as "Restart in Linux..."
- better: if only one Linux disk (should be overwhelming majority): just show "Restart in Linux..."
- better: if several, list actual names of all disks in the main menu (e.g. "Restart in 'Fedora Linux'..., etc")
- better: if only one Linux disk (should be overwhelming majority): just show "Restart in Linux..." in UI
- better: if several, list actual names of all disks in the main menu
- (e.g. "Restart in Macintosh HD...", "Restart in 'Fedora Linux'... etc)

- [ ] 4: (HOPEFULLY NOT NECESSARY) Some kind of first-use-wizard?
- reason why not: UX should be good enough to not require wizard
Expand Down Expand Up @@ -250,6 +265,8 @@
- Able to restart to any OS (all Linux and macOS disks)
- Able to change the default Startup Disk
- Other "Asahi Linux" tasks?
- [ ] Do the menus look wonky? What if the icon is moved to the right etc?
- [ ] Do the macOS/Linux versions of this app look and feel similar enough?
- [ ] Does restarting honor what the user has previously selected in the macOS system Restart dialog ("Reopen windows when logging back in")?
- Test both settings, both "reopen" and "don't reopen", do the windows actually reopen after logging back in or not?
- [ ] Is cancelling before restarting handled gracefully?
Expand All @@ -258,7 +275,6 @@
- [ ] What happens if the default Startup Disk is already Linux/macOS and user tries to use the app to restart to that?
- Is the UX different? Should it be? (No? Just always have consistent UX?)
- [ ] What happens if there are no "Linux" disks available?
- [ ] What happens if the previously selected "Linux" disk can't be found?
- [ ] What happens if the user cancels an active restarting process? Is NVRAM now different than before?
- [ ] Does everything look fine with both macOS themes (Dark/Light)?
- [ ] Does "System Options / Accessibility / Keyboard settings / Keyboard navigation" behave like in other apps?
Expand All @@ -271,6 +287,8 @@
- [ ] Is behavior acceptable compared to current macOS "Restart..." dialog / workflow?
- [ ] Has something changed in macOS? Does something need to be changed in this app to compensate?
- [ ] Has a relevant Asahi Linux related thing changed? Does something need to be changed in this app to compensate?
- [ ] README and TODO: are macOS/Linux versions roughly similar, i.e. have they been kept in lockstep?
- I sure hope so, must be annoying to fix it not
- [ ] The actual point of this project: Does using the Asahi Linux installer automatically add "Restart in Linux"
menubar icon in a useful state (no password prompt or other stupid questions asked)?

Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Asahi Restart Helper (macOS version)
# Asahi Restart Helper<br>(macOS version)

**Asahi Restart Helper** is a macOS menu bar app that makes it easy to restart in Linux.
- You can keep macOS as the default Startup Disk if you want (uses Linux for this restart only!)
<img src="./misc/Menu_Screenshot.png" width="25%" alt="Main menu screenshot"><br>

**Note: the name (and icon) are still just placeholders. Any detail may change in the future.**
**Asahi Restart Helper** adds a macOS menu bar icon that makes it easy to restart in Linux.
- You can keep macOS as the default Startup Disk if you want (uses Linux for this restart only!)

The app can also be used to restart back into macOS itself while keeping Linux as the default Startup Disk.

Note: You will be able to install the corresponding Linux version of this app too, to also get the same functionality on Asahi Linux (KDE Plasma or GNOME).
**NOTE: project name, scope, icon and UI are still in heavy flux. Any details may change in the future. If you find bugs or have suggestions, please open an issue.**

Note: You can also install the corresponding Linux version of this app, to get the same functionality on Asahi Linux (KDE Plasma or GNOME). (todo: add link)

## Screenshots:

Expand Down Expand Up @@ -68,28 +70,28 @@ Download:
- Asahi Linux must already be installed on the computer
- Can't launch Asahi Linux installer from this app, at least for now

## Project goals:
## Goals:
- The actual point of this app: after using the official Asahi Linux installer, make it easy to reboot using the "other" OS,
instead of requiring the user to already know the holding-down-the-power-button trick
(and/or to already know how to change the default startup disk)
- Help users conveniently boot to Linux from macOS (Linux version (todo) for the other way around)
- Help users conveniently boot to Linux from macOS (use the Linux version for the other way around)
- Don't be annoying
- Don't be stupid
- Keep it simple
- Use non-technical language (give newbies a chance, experts will know how to use the app regardless of word choices)
- Hide implementation details, but if the user wants to know how and why, explain in the help dialog

## Stretch goals:
- Somehow convince official Asahi installer to automatically install this app (icon in user's macOS menubar)
- Somehow convince the official Asahi installer to automatically install this app (icon in user's macOS menubar)
- Somehow convince Asahi project to take over and adopt this app
(have someone else maintain it, and fix the code if necessary)
- Bonus: somehow convince Asahi installer to not silently make Asahi Linux the default Startup Disk and
not completely hide all evidence of user's macOS installation ever existing by default (!)

### (Stretch goals for the upcoming Linux version)
- Somehow convince whatever Asahi installer installs (currently Fedora Asahi Remix) to automatically
- Somehow convince whatever the Asahi installer installs (currently Fedora Asahi Remix) to automatically
install a corresponding app icon in Linux too (todo: implement Linux version of this app)
- Also install the extension that allows showing the icon on Gnome? (KDE Plasma allows showing icon by default)
- Also install the extension that allows showing the icon on Gnome? (KDE Plasma allows showing the icon by default)
- Bonus: somehow convince the developer of "asahi-bless" (Linux "bless" counterpart) to add the necessary
command line options, and generally make the tool easier to use
- Bonus: somehow convince whatever Asahi installer installs (currently Fedora Asahi Remix) to automatically
Expand Down

0 comments on commit bd05e62

Please sign in to comment.