From 7a92af4619876a9f2abcd59640b3796ae375935e Mon Sep 17 00:00:00 2001
From: Cleve Stuart <cleve.stuart@fauna.com>
Date: Mon, 5 Feb 2024 06:58:19 -0800
Subject: [PATCH] Clarify developer setup

---
 DEVELOPERS.md | 18 +++++++++++++++---
 package.json  |  3 ++-
 2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/DEVELOPERS.md b/DEVELOPERS.md
index 35c4cca..55ef8ab 100644
--- a/DEVELOPERS.md
+++ b/DEVELOPERS.md
@@ -1,7 +1,19 @@
-## Developing the Extension
+# Developing the Extension
 
-Open vscode in this directory, and hit F5 to run a new version of
-vscode, which will have this plugin running.
+## Setup
+Before launching you'll need to fetch the analzyer locally and compile this app:
+
+```
+yarn developer-setup
+```
+
+
+## Launching
+Now to launch:
+
+Open vscode in this directory, and select "Run -> Start Debugging" from the menu,
+there is an `F5` shortcut for this on some systems with some keybindings. This will
+launch a parallel instance of VS code with the local extension running.
 
 Now in this new instance of vscode, press cmd+l/ctrl+l to open the FQL Playground.
 This should have syntax highlighting, and a language server should give live
diff --git a/package.json b/package.json
index 1969517..43812e3 100644
--- a/package.json
+++ b/package.json
@@ -41,6 +41,7 @@
   "scripts": {
     "vscode:prepublish": "yarn run compile",
     "compile": "tsc -p ./",
+    "developer-setup": "yarn install && yarn compile && yarn download-analyzer",
     "download-analyzer": "bash ./scripts/download-analyzer.sh",
     "watch": "tsc -watch -p ./",
     "pretest": "yarn run compile && yarn run lint && yarn run download-analyzer",
@@ -65,7 +66,7 @@
         "fauna.dbSecret": {
           "type": "string",
           "default": "",
-          "description": "The secret to use to connnect to your fauna database.",
+          "description": "The secret used to connect to your fauna database.",
           "scope": "window"
         },
         "fauna.endpoint": {