Update README.md

For this to work you'll need to put this in your ~/.zshrc (or equivalent rc file):

lg()
{
    export LAZYGIT_NEW_DIR_FILE=/Users/jesseduffieldduffield/Library/Application\ Support/jesseduffield/lazygit/.lastd

    lazygit "$@"

    if [ -f $LAZYGIT_NEW_DIR_FILE ]; then
            cd "$(cat $LAZYGIT_NEW_DIR_FILE)"
            rm -f $LAZYGIT_NEW_DIR_FILE > /dev/null
    fi
}

README.md

@@ -24,8 +24,16 @@ Github Sponsors is matching all donations dollar-for-dollar for 12 months so if
 ## Installation
 
 ### Homebrew
+Normally the lazygit formula can be found in the Homebrew core but we suggest you tap our formula to get the frequently updated one. It works with Linux, too.
 
-```sh
+Tap:
+```
+brew install jesseduffield/lazygit/lazygit
+```
+
+Core:
+
+```
 brew install lazygit
 ```
 
@@ -110,6 +118,24 @@ whichever rc file you're using).
 - Rebase Magic tutorial [here](https://youtu.be/4XaToVut_hs)
 - List of keybindings
   [here](/docs/keybindings).
+  
+## Changing Directory On Exit
+
+If you change repos in lazygit and want your shell to change directory into that repo on exiting lazygit, add this to your `~./zhsrc` (or other rc file):
+```
+lg()
+{
+    export LAZYGIT_NEW_DIR_FILE=~/.lazygit/newdir
+
+    lazygit "$@"
+
+    if [ -f $LAZYGIT_NEW_DIR_FILE ]; then
+            cd "$(cat $LAZYGIT_NEW_DIR_FILE)"
+            rm -f $LAZYGIT_NEW_DIR_FILE > /dev/null
+    fi
+}
+```
+Then `source ~/.zshrc` and from now on when you call `lg` and exit you'll switch directories to whatever you were in inside lazyigt. To override this behaviour you can exit using `shift+Q` rather than just `q`.
 
 ## Cool features
 

pkg/gui/gui.go

@@ -160,6 +160,7 @@ type guiState struct {
 	Context             string // important not to set this value directly but to use gui.changeContext("new context")
 	CherryPickedCommits []*commands.Commit
 	SplitMainPanel      bool
+	RetainOriginalDir   bool
 }
 
 // for now the split view will always be on
@@ -779,6 +780,12 @@ func (gui *Gui) RunWithSubprocesses() error {
 	for {
 		if err := gui.Run(); err != nil {
 			if err == gocui.ErrQuit {
+				if !gui.State.RetainOriginalDir {
+					if err := gui.recordCurrentDirectory(); err != nil {
+						return err
+					}
+				}
+
 				break
 			} else if err == gui.Errors.ErrSwitchRepo {
 				continue
@@ -818,18 +825,6 @@ func (gui *Gui) runCommand() error {
 	return nil
 }
 
-func (gui *Gui) quit(g *gocui.Gui, v *gocui.View) error {
-	if gui.State.Updating {
-		return gui.createUpdateQuitConfirmation(g, v)
-	}
-	if gui.Config.GetUserConfig().GetBool("confirmOnQuit") {
-		return gui.createConfirmationPanel(g, v, true, "", gui.Tr.SLocalize("ConfirmQuit"), func(g *gocui.Gui, v *gocui.View) error {
-			return gocui.ErrQuit
-		}, nil)
-	}
-	return gocui.ErrQuit
-}
-
 func (gui *Gui) handleDonate(g *gocui.Gui, v *gocui.View) error {
 	if !gui.g.Mouse {
 		return nil

pkg/gui/keybindings.go

@@ -72,17 +72,22 @@ func (gui *Gui) GetInitialKeybindings() []*Binding {
 			ViewName: "",
 			Key:      'q',
 			Modifier: gocui.ModNone,
-			Handler:  gui.quit,
+			Handler:  gui.handleQuit,
+		}, {
+			ViewName: "",
+			Key:      'Q',
+			Modifier: gocui.ModNone,
+			Handler:  gui.handleQuitWithoutChangingDirectory,
 		}, {
 			ViewName: "",
 			Key:      gocui.KeyCtrlC,
 			Modifier: gocui.ModNone,
-			Handler:  gui.quit,
+			Handler:  gui.handleQuit,
 		}, {
 			ViewName: "",
 			Key:      gocui.KeyEsc,
 			Modifier: gocui.ModNone,
-			Handler:  gui.quit,
+			Handler:  gui.handleQuit,
 		}, {
 			ViewName:    "",
 			Key:         gocui.KeyPgup,

pkg/gui/quitting.go

@@ -0,0 +1,48 @@
+package gui
+
+import (
+	"os"
+
+	"github.com/jesseduffield/gocui"
+)
+
+// when a user runs lazygit with the LAZYGIT_NEW_DIR_FILE env variable defined
+// we will write the current directory to that file on exit so that their
+// shell can then change to that directory. That means you don't get kicked
+// back to the directory that you started with.
+func (gui *Gui) recordCurrentDirectory() error {
+	if os.Getenv("LAZYGIT_NEW_DIR_FILE") == "" {
+		return nil
+	}
+
+	// determine current directory, set it in LAZYGIT_NEW_DIR_FILE
+	dirName, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+
+	return gui.OSCommand.CreateFileWithContent(os.Getenv("LAZYGIT_NEW_DIR_FILE"), dirName)
+}
+
+func (gui *Gui) handleQuitWithoutChangingDirectory(g *gocui.Gui, v *gocui.View) error {
+	gui.State.RetainOriginalDir = true
+	return gui.quit(v)
+}
+
+func (gui *Gui) handleQuit(g *gocui.Gui, v *gocui.View) error {
+	gui.State.RetainOriginalDir = false
+	return gui.quit(v)
+}
+
+func (gui *Gui) quit(v *gocui.View) error {
+	if gui.State.Updating {
+		return gui.createUpdateQuitConfirmation(gui.g, v)
+	}
+	if gui.Config.GetUserConfig().GetBool("confirmOnQuit") {
+		return gui.createConfirmationPanel(gui.g, v, true, "", gui.Tr.SLocalize("ConfirmQuit"), func(g *gocui.Gui, v *gocui.View) error {
+			return gocui.ErrQuit
+		}, nil)
+	}
+
+	return gocui.ErrQuit
+}