From 295409b0b4bc7a1cbafdb654257909f9bd9ac68a Mon Sep 17 00:00:00 2001 From: Kyle Carberry Date: Tue, 19 Sep 2023 11:20:44 -0500 Subject: [PATCH] Update README for contributing --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index a97ec6e..837c3dd 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,22 @@ To quickly start contributing with a new module, clone this repository and run: ```sh ./new.sh ``` + +Test a module by running an instance of Coder on your local machine: + +```bash +$ coder server --in-memory +``` + +Create a template and edit it to include your development module: + +> *Info* +> The Docker starter template is recommended for quick-iteration! + +```tf +module "testing" { + source = "/home/user/coder/modules/my-new-module" +} +``` + +Now create a workspace, and any resources you've created in your module should appear! 🥳