diff --git a/README.md b/README.md index b694aed..ca2f463 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ **Asahi Linux 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!) -The app can also be used to restart back into macOS itself, while keeping Linux as the default Startup Disk. +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). @@ -29,25 +29,26 @@ Preferences dialog (temporary placeholder UI)
Change default startup disk dialog
The app can also be used to change the default Startup Disk directly from the menu
(for parity with the future Linux version) -(using the app to restart doesn't require changing the default though) +(using the app to restart doesn't require changing the default) --- ## Opening the Project in Xcode: -1. Clone the repository: `git clone (URL)` or download the zip file and extract it. -2. Launch Xcode, choose "Open another project...". +1. Clone the repository: `git clone (URL)` or download the zip file and extract it +2. Launch Xcode, choose "Open another project..." 3. Navigate to the new folder (Xcode will automatically look for and open the `.xcodeproj` file) 4. You should now be able to build and test the project (please open a new issue if that was not the case!) ## High-level technical explanation: -The app adds a menu bar icon that offers a convenient way to first use `bless --nextboot` so set the temporary Startup Disk for this restart only, and then restarts. +The app adds a menu bar icon that offers a convenient way to first use `bless --nextboot` to set the temporary Startup Disk for this restart only, and then restarts. So basically a pretty GUI for the following: 1. Runs `sudo bless --mount "/Volumes/Linux Disk Name/" --setBoot --nextonly` 2. Then restarts the computer relatively gracefully - - the app is not allowed to use the system restart dialog directly, but restarting seems to honor the previously selected "Reopen windows when logging back in" setting (todo: test thoroughly before promising anything) + - The app is not allowed to directly use and show the macOS standard Restart dialog + - Seems to honor the previously selected "Reopen windows when logging back in" setting from that dialog though (?) ## Download initial demo version: @@ -74,7 +75,7 @@ Download: - 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 explicitly wants to know how and why, explain in the help dialog +- 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) @@ -86,7 +87,7 @@ Download: ### (Stretch goals for the upcoming Linux version) - Somehow convince whatever 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 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 @@ -96,7 +97,6 @@ Download: - Don't support macOS versions older than 12.3 (only support what the Asahi Linux installer supports) - Don't support Intel Macs (only support what the Asahi Linux installer supports) - Don't implement anything that could be considered "scope creep" -- NOTE: is being "Asahi Linux Helper" scope creep: should this be strictly "Restart in Linux" (and "Restart in macOS")? +- NOTE: is being "Asahi Linux Helper" scope creep? Should this project be strictly "Restart in Linux"? # See also: [TODO.md](./Asahi%20Linux%20Helper/TODO.md) -