repos / zmx

commit

0a8bd81

parent

927bc64

author

Eric Bower

date

2025-12-28 21:31:05 -0500 EST

docs: readme

 1@@ -46,7 +46,7 @@ zig build -Doptimize=ReleaseSafe --prefix ~/.local
 2 ## usage
 3 
 4 > [!IMPORTANT]
 5-> Press `ctrl+\` to detach from the session.
 6+> We recommend closing the terminal window to detach from the session but you can also press `ctrl+\` or run `zmx detach`.
 7 
 8 ```
 9 Usage: zmx <command> [args]
10@@ -70,10 +70,6 @@ zmx attach build make -j8   # run a build, reattach to check progress
11 zmx attach mux dvtm         # run a multiplexer inside zmx
12 ```
13 
14-### detach
15-
16-While we try our best to support detaching from the terminal session using multiple mechanisms (e.g. shortcut, detach command) we find ourselves simply closing terminal windows when we want to detach from a `zmx` session.  Whenever you attach to a `zmx` session we make sure that it stays alive so explicitly detaching feels unnecessary unless for some reason you need to reuse the same exact terminal window.
17-
18 ## shell prompt
19 
20 When you attach to a `zmx` session, we don't provide any indication that you are inside `zmx`. We do provide an environment variable `ZMX_SESSION` which contains the session name.