From fcd7a8d7f6641ac2464c8e99cc7834a308accea2 Mon Sep 17 00:00:00 2001 From: Pat O'Connor Date: Sat, 15 Mar 2025 21:44:52 +0000 Subject: [PATCH] task(GUIDEFRAME-42): create guideframe template repo Signed-off-by: Pat O'Connor --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7269c08..810808b 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,8 @@ GuideFrame is packaged and available on pypi. It can be installed using: Once installed, you will need to install the non-python dependencies. A setup script is packaged with GuideFrame for this. You can simply copy it from the GuideFrame repo and run it locally or you can run the following: ```bash $(python -c "import guideframe, os; print(os.path.join(os.path.dirname(guideframe.__file__), 'setup_env.sh'))")``` + +In aid of illustrating the basics of GuideFrame, a template repository has been created and can be found here: +https://github.com/chipspeak/GuideFrame-Template + +This repository walks a user through the installation process in addition to providing some basics around the workings of GuideFrame in addition to some basic templates.