Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hraban committed Nov 21, 2023
1 parent 00f5a63 commit f48ce3f
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
* Utilities for Mac App launchers
* (Nix) Utilities for Mac App launchers

- =mktrampoline= :: Create a “trampoline” launcher app
- =sync-dock= :: Update persistent apps in the Dock
- =sync-trampolines= :: Create a directory with trampolines to all your apps
** How to use in Nix

Made with Nix in mind.
Use the home-manager module to "fix" your .app launchers:

** How to use in Nix
- Pinning in Dock works across updates
- Launch from Spotlight

Now you can launch Nix-installed apps using only your keyboard, using @@html:<kbd>@@⌘ space@@html:</kbd>@@.

*** Flakes

Expand Down Expand Up @@ -52,8 +53,6 @@ How to use this in nix-darwin or home-manager, assuming you use flakes:
}
#+end_src

This will automatically “do the right thing”.

*** Non-flakes

Since I use flakes for home manager and nix-darwin I’m not 100% on how to do this, but I suspect that it’s similar to the above, at its core.
Expand Down Expand Up @@ -84,6 +83,14 @@ mac-app-util.darwinModules.default
#+end_src

The rest is up to you. Good luck!
** Commands

At the core of this project is a (Nix-agnostic) program that can:

- =mktrampoline= :: Create a “trampoline” launcher app
- =sync-dock= :: Update persistent apps in the Dock
- =sync-trampolines= :: Create a directory with trampolines to all your apps

** mktrampoline

This creates a “trampoline” launcher app which is a simple wrapper application that just launches your actual application.
Expand Down

0 comments on commit f48ce3f

Please sign in to comment.