From c716c160b16e77834e5b9ae7e23c1611f20ffad8 Mon Sep 17 00:00:00 2001 From: Michael Neale Date: Fri, 11 Oct 2024 17:36:50 +1100 Subject: [PATCH] docs: goosehints doc fix only (#142) --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f980ff7..098582b3 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,6 @@ To install Goose, use `pipx`. First ensure [pipx][pipx] is installed: brew install pipx pipx ensurepath ``` -You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you. Then install Goose: @@ -131,7 +130,11 @@ You will see the Goose prompt `G❯`: G❯ type your instructions here exactly as you would tell a developer. ``` -Now you are interacting with Goose in conversational sessions - something like a natural language driven code interpreter. The default toolkit allows Goose to take actions through shell commands and file edits. You can interrupt Goose with `CTRL+D` or `ESC+Enter` at any time to help redirect its efforts. +Now you are interacting with Goose in conversational sessions - think of it as like giving direction to a junior developer. The default toolkit allows Goose to take actions through shell commands and file edits. You can interrupt Goose with `CTRL+D` or `ESC+Enter` at any time to help redirect its efforts. + +> [!TIP] +> You can place a `.goosehints` text file in any directory you launch goose from to give it some background info for new sessions in plain language (eg how to test, what instructions to read to get started or just tell it to read the README!) You can also put a global one `~/.config/goose/.goosehints` if you like for always loaded hints personal to you. + #### Exit the session