Skip to content

task(GUIDEFRAME-61): adjusted typos in installation #50

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 27, 2025
Merged

task(GUIDEFRAME-61): adjusted typos in installation #50

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
4 changes: 2 additions & 2 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ 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'))")```
```$(python -c "import guideframe, os; print(os.path.join(os.path.dirname(guideframe.__file__), 'setup_env.sh'))")```

Alternatively, depending on you operating system, you can run the following to install the package and dependencies in one:

Expand All @@ -42,6 +42,6 @@ Alternatively, depending on you operating system, you can run the following to i

You will then need to create a GuideFrame script. See the repository link above for a template. Once this script has been created, you can run it using:

```bash python <guideframe_script_name> <system_argument>```
```python <guideframe_script_name> <system_argument>```

Note: GuideFrame currently supports ```macos``` as its system argument. You can also pass: ```github``` to run on an ubuntu system but this has not been tested outside of virtual machines.