Skip to content

task(GUIDEFRAME-42): create guideframe template repo #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chipspeak merged 1 commit into from
Mar 15, 2025
Merged

task(GUIDEFRAME-42): create guideframe template repo #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.