Skip to content

task(GUIDEFRAME-61): added demo section to site #47

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): added demo section to site #47

Show file tree
Hide file tree
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

GuideFrame is a tool which allows software developers to produce detailed walkthrough videos of their projects using python code. It can be run locally, provided you have the required packages installed, or can be used as a GitHub action.

It uses a selection of open-source software to record a users screen, perform scripted UI interactions and generate a matching voiceover based on a user-defined markdown file.
It uses a selection of open-source software to record a users screen, perform scripted UI interactions and generate a matching voiceover based on a user-defined markdown file. To see GuideFrame in action you can visit the [Demos section of the GuideFrame Site](https://chipspeak.github.io/GuideFrame/demos/).

## Installation

GuideFrame is currently available on PyPi. It can be installed using:`pip install guideframe`.
While GuideFrame can be run locally, given the variance in development environment, using it as part of a GitHub action is the recommended approach.

More detailed installation instructions can be found on the official docs page [here](https://chipspeak.github.io/GuideFrame/installation/).
More detailed installation instructions can be found on the docs page [here](https://chipspeak.github.io/GuideFrame/installation/).

## Getting Started

Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: GuideFrame Docs
description: The official documentation for GuideFrame.
title: GuideFrame
description: The official site for GuideFrame.
theme: just-the-docs

url: https://chipspeak.github.io/GuideFrame
Expand Down
Loading