From a3cbbbad05143168b1b753e8f4cef5de9772a22f Mon Sep 17 00:00:00 2001 From: tylerslaton Date: Thu, 29 Feb 2024 11:16:10 -0500 Subject: [PATCH] docs: separate shell command from output in examples Signed-off-by: tylerslaton --- README.md | 10 ++++++---- docs/docs/01-overview.md | 4 ++-- docs/docs/100-tools/100-tools.md | 5 +++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 99a19a6f..73ab9a78 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,10 @@ Form and run a SQL query to find the artist with the most number of albums and o the result of that. When done remove the database file and the downloaded content. +```shell +$ gptscript ./example.gpt ``` ``` -$ gptscript ./example.gpt - OUTPUT: The artist with the most number of albums in the database is Iron Maiden, with a total @@ -89,7 +89,8 @@ $env:OPENAI = 'your-api-key' ```shell gptscript https://get.gptscript.ai/echo.gpt --input 'Hello, World!' - +``` +``` OUTPUT: Hello, World! @@ -134,7 +135,8 @@ When asked how I am doing, respond with "Thanks for asking "${question}", I'm do Put the above content in a file named `bob.gpt` and run the following command: ```shell $ gptscript bob.gpt - +``` +``` OUTPUT: Bob said, "Thanks for asking 'How are you doing?', I'm doing great fellow friendly AI tool!" diff --git a/docs/docs/01-overview.md b/docs/docs/01-overview.md index e5893170..b923790a 100644 --- a/docs/docs/01-overview.md +++ b/docs/docs/01-overview.md @@ -26,10 +26,10 @@ Form and run a SQL query to find the artist with the most number of albums and o the result of that. When done remove the database file and the downloaded content. +```shell +$ gptscript ./example.gpt ``` ``` -$ gptscript ./example.gpt - OUTPUT: The artist with the most number of albums in the database is Iron Maiden, with a total diff --git a/docs/docs/100-tools/100-tools.md b/docs/docs/100-tools/100-tools.md index e172cbff..111a0ace 100644 --- a/docs/docs/100-tools/100-tools.md +++ b/docs/docs/100-tools/100-tools.md @@ -23,9 +23,10 @@ When asked how I am doing, respond with "Thanks for asking "${question}", I'm do Put the above content in a file named `bob.gpt` and run the following command: -```sh +```shell $ gptscript bob.gpt - +``` +``` OUTPUT: Bob said, "Thanks for asking 'How are you doing?', I'm doing great fellow friendly AI tool!"