From eef7b292233e046492c5cf384eefdcb44c7a781c Mon Sep 17 00:00:00 2001 From: Andy Burke Date: Tue, 24 Jun 2025 15:53:16 -0700 Subject: [PATCH] docs: update readme with improved getting started instructions --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f38bfb8..b583423 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,28 @@ ## Getting Started Developing -Run their shell script (note: as yourself, not root) +1) Install Deno -``` -curl -fsSL https://deno.land/install.sh | sh -``` + Run their shell script (note: as yourself, not root) -Using Nix: + ``` + curl -fsSL https://deno.land/install.sh | sh + ``` -``` -nix-shell -p deno -``` + Or using Nix: -`deno run task serve` + ``` + nix-shell -p deno + ``` -navigate to http://localhost:8000 +2) Clone the repo: + + `git clone https://andyburke.dev/andyburke/autonomous.contact.git` + +3) Start the server: + + `deno run task serve` + +4) Navigate to http://localhost:8000 ## TODO