Skip to content

Commit

Permalink
Added tutorial maker
Browse files Browse the repository at this point in the history
  • Loading branch information
jzongker committed Oct 3, 2024
1 parent 1c00928 commit 279e749
Show file tree
Hide file tree
Showing 39 changed files with 151 additions and 32 deletions.
Binary file removed lessons/scripts/register/output.mp3
Binary file not shown.
32 changes: 0 additions & 32 deletions lessons/scripts/register/script.xml

This file was deleted.

19 changes: 19 additions & 0 deletions tutorial-maker/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: page
app: lessons
section: Tutorial Maker
title: How to Make Tutorials
---

# How to Make Tutorials

## Installing Tutorial Maker
<video src="../videos/tutorial-maker/install/output.mp4" />

## Creating a Tutorial Script
<video src="../videos/tutorial-maker/create/output.mp4" />

## Running the Tutorial Maker
<video src="../videos/tutorial-maker/run/output.mp4" />


File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file not shown.
34 changes: 34 additions & 0 deletions videos/lessons/register/script.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<tutorial>
<speak>
<mark name="1" />
To register an account, click the register button in the top right corner.
<break time="1s"/>
<mark name="2" />
Enter your name and your email address and click "Register"
<break time="1s"/>
<mark name="3" />
You will receive an email with the next steps.
<break time="1s"/>
Click the link in the email and you'll be prompted to set a password.
<break time="1s"/>
<mark name="4" />
Enter your password, and verify it, then click the "Sign In" button.
<break time="1s"/>
<mark name="5" />
Next you'll be prompted to search for your church.
<break time="1s"/>
Search for your church to see if it already exists.
<break time="1s"/>
<mark name="6" />
If not, come to the bottom and click the "Register a New Church" link.
<break time="1s"/>
<mark name="7" />
And click "OK".
<mark name="8" />
<break time="1s"/>
Enter your church information and click "Save".
<mark name="9" />
<break time="2s"/>
<mark name="end" />
</speak>
</tutorial>
Binary file added videos/tutorial-maker/create/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/create/output.mp4
Binary file not shown.
29 changes: 29 additions & 0 deletions videos/tutorial-maker/create/script.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<tutorial>
<speak>
<mark name="1" />
Create a new folder and add a script.xml file to it.
<break time="1s"/>
<mark name="2" />
Add any screenshots you wish to use in the tutorial to the same folder. Name the first one 1 dot png and continue that pattern.
<break time="1s"/>
<mark name="3" />
In script.xml, add a tutorial tag at the top level, followed by a speak tag.
<break time="1s"/>
<mark name="4" />
Add a mark tag with a name attribute of "1" to load the first screenshot.
<break time="1s"/>
<mark name="5" />
Add the text you would like to be spoken for the first step.
<break time="1s"/>
<mark name="6" />
Add a break tag with a time attribute of "1 S" to pause for a second.
<break time="1s"/>
<mark name="7" />
Continue to add mark, speak, and break tags for each step in the tutorial.
<break time="1s"/>
<mark name="8" />
End the tutorial with a 2 second break and a mark tag with a name attribute of "end".
<break time="2s"/>
<mark name="end" />
</speak>
</tutorial>
Binary file added videos/tutorial-maker/install/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/install/output.mp4
Binary file not shown.
23 changes: 23 additions & 0 deletions videos/tutorial-maker/install/script.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<tutorial>
<speak>
<mark name="1" />
If you haven't already, download and install NodeJS from nodejs.org.
<break time="1s"/>
<mark name="2" />
Download F F mpeg for your operating system from f f mpeg dot org.
<break time="1s"/>
<mark name="3" />
Unzip the F F mpeg bin folder to a folder of your choice on your hard drive.
<break time="1s"/>
<mark name="4" />
Add that folder to your system's PATH. On windows this is done from Environment Variables.
<break time="1s"/>
<mark name="5" />
Clone the tutorial-maker repository from github.
<break time="1s"/>
<mark name="6" />
Run "npm install -g" to install the tutorial-maker globally.
<break time="2s"/>
<mark name="end" />
</speak>
</tutorial>
Binary file added videos/tutorial-maker/run/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/run/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added videos/tutorial-maker/run/3.png
Binary file added videos/tutorial-maker/run/4.png
Binary file added videos/tutorial-maker/run/output.mp4
Binary file not shown.
17 changes: 17 additions & 0 deletions videos/tutorial-maker/run/script.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<tutorial>
<speak>
<mark name="1" />
Open a command prompt. On windows you can run the "cmd" command to do so.
<break time="1s"/>
<mark name="2" />
Navigate to the folder with your script and images.
<break time="1s"/>
<mark name="3" />
Run "tutorial-maker" to turn the script and images into a video.
<break time="1s"/>
<mark name="4" />
When the process completes, you will have a new video called output.mp4 in the same folder.
<break time="2s"/>
<mark name="end" />
</speak>
</tutorial>
29 changes: 29 additions & 0 deletions videos/tutorial-maker/tmp/script.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<tutorial>
<speak>
<mark name="1" />
Create a new folder and add a script.xml file to it.
<break time="1s"/>
<mark name="2" />
Add any screenshots you wish to use in the tutorial to the same folder. Name the first one 1.png and continue that pattern.
<break time="1s"/>
<mark name="3" />
In script.xml, add a tutorial tag at the top level, followed by a speak tag.
<break time="1s"/>
<mark name="4" />
Add a mark tag with a name attribute of "1" to load the first screenshot.
<break time="1s"/>
<mark name="5" />
Add the text you would like to be spoken for the first step.
<break time="1s"/>
<mark name="6" />
Add a break tag with a time attribute of "1s" to pause for a second.
<break time="1s"/>
<mark name="7" />
Continue to add mark, speak, and break tags for each step in the tutorial.
<break time="1s"/>
<mark name="8" />
End the tutorial with a 2 second break and a mark tag with a name attribute of "end".
<break time="2s"/>
<mark name="end" />
</speak>
</tutorial>

0 comments on commit 279e749

Please sign in to comment.