Skip to content

Commit 54aac16

Browse files
authored
Merge pull request #47 from chipspeak/GUIDEFRAME-61
task(GUIDEFRAME-61): added demo section to site
2 parents 6ac432a + 3a96a3c commit 54aac16

7 files changed

Lines changed: 940 additions & 5 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
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.
44

5-
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.
5+
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/).
66

77
## Installation
88

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

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

1414
## Getting Started
1515

docs/_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
title: GuideFrame Docs
2-
description: The official documentation for GuideFrame.
1+
title: GuideFrame
2+
description: The official site for GuideFrame.
33
theme: just-the-docs
44

55
url: https://chipspeak.github.io/GuideFrame

0 commit comments

Comments
 (0)