From 0f0875abf4513ae76d0336a7dc9ba0493aeb8e12 Mon Sep 17 00:00:00 2001
From: gwen windflower <gwenwindflower@gmail.com>
Date: Sun, 17 Mar 2024 07:43:50 -0500
Subject: [PATCH] Expand README

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 44 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 11a2ff9..a5a1e65 100644
--- a/README.md
+++ b/README.md
@@ -12,20 +12,57 @@ The easiest way to get started is with `task`. `task` is like `make`, but simple
 brew install go-task
 scoop install task
 yay -S go-task-bin
-# etc
+# etc...
+# consider aliasing task to t in your .zshrc or .bashrc
+# if you like it
+# and that alias is free
 ```
 
-From there, as long as you're in the root of the project you can:
+From there, as long as you're _in the root of the project_ you can:
 
 ```bash
-task setup # or task s -- setup the project, install dependencies in a virtual environment
-task build # or task b -- build the dbt project
-task test # or task t -- run the dbt tests
-task bi # build and serve the Evidence BI site locally
+# or task s -- setup the project, install dependencies in a virtual environment
+# probably only needs to be run once, or when you want to reset the project
+task setup
+# or task b -- build the dbt project
+task build
+ # or task t -- run the dbt tests
+task test
+# build and serve the Evidence BI site locally
+task bi
+# the primary dev command, refresh the dbt build, then build and serve Evidence
+task bbi
+# if you aliased task to t, you can run commands really quickly like this
+t bbi
+# I also recommend Amazon CodeWhisperer which will provide auto-completion
+# for the available task commands it finds in the Taskfile.yml
+# https://docs.aws.amazon.com/codewhisperer/latest/userguide/command-line.html
 ```
 
-You don't need to be in an active virtual environment, these commands will take care of that. If you want to run commands directly once you get a handle on the project, you will need to activate the venv first.
+You **don't** need to be in an active virtual environment, these commands will take care of that (they'll work just fine if you are though too). If you want to run commands directly once you get a handle on the project, you will need to activate the venv first.
+
+```bash
+source .venv/bin/activate
+# another command i highly recommend aliasing to something like `va`
+# deactivate a virtual environment with:
+deactivate
+# i like aliasing this to `da`
+
+# Important commands if you're running things directly:
+# Once in the virtual environment, install the dependencies
+python3 -m pip install --upgrage pip && python3 -m pip install -r requirements.txt
+# Note you'll need to *reactivate* the virtual environment to pick up the newly installed dependencies
+# Build the dbt project
+dbt build
+# Run the dbt tests
+dbt test
+# Build and serve Evidence
+npm --prefix ./reports run sources && npm --prefix ./reports run dev
+```
+
+```
 
 ## More soon
 
 I like to write pretty extensive and beginner-friendly docs for my projects. This one will be no exception. More documentation is coming soon.
+```