guix/videos
2
0
Fork 0
mirror of git://git.savannah.gnu.org/guix/videos.git synced 2024-12-29 11:40:23 +01:00
Code Issues Releases Wiki Activity

README: fix typos and improve formatting

Browse source
This commit is contained in:
Paul Garlick 2019-03-20 12:12:59 +00:00
parent 8fa4a5c065
commit 3e0304bff6
No known key found for this signature in database
GPG key ID: AAC7E891896B568A
1 changed files with 101 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

197
README
View file

@ -1,71 +1,74 @@
* INTRODUCTION * INTRODUCTION
################ THIS IS A WIP README, will be improved in the ################ THIS IS A WIP README, will be improved in the
following iterations.######################## following iterations.########################
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
NOTE: to build the videos run: build-video.sh. NOTE: to build the videos run: build-video.sh.
This script has two modes, if a video directory is supplied as an argument,
then that video will be build. If no argument is supplied, it will attempt This script has two modes, if a video directory is supplied as an
to build all videos. If additional top level directories are created in argument, then that video will be built. If no argument is supplied,
the repository, which are not video directories, then this script needs it will attempt to build all videos. If additional top level
to be adjusted. directories are created in the repository, which are not video
directories, then this script needs to be adjusted.
NOTE: to work on the videos run the following scripts, in this order: NOTE: to work on the videos run the following scripts, in this order:
environment.sh 1) environment.sh
install-fonts.sh. 2) install-fonts.sh.
This sets up a development environment. This sets up a development environment.
To build a video in the development environment run the buildall.sh in the To build a video in the development environment run the buildall.sh in
video directory. the video directory.
In the latter case, the script will take some time to execute, so please, In the latter case, the script will take some time to execute, so
don't cancel it unless you want to stop the video creation. please, don't cancel it unless you want to stop the video creation.
Bellow you will find the explanation for each step inside these scripts. Bellow you will find the explanation for each step inside these
scripts.
NOTE2: After creating the videos with this script, you can delete them by NOTE2: After creating the videos with this script, you can delete them
running make VIDEO=<video-name> clean, and have your directory clean like by running make VIDEO=<video-name> clean, and have your directory
if you have just cloned it. clean like if you have just cloned it.
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
The idea is to help you in the video creation steps. Each video will The idea is to help you in the video creation steps. Each video will
be composed of slide videos showing concepts - a.k.a noCli - be composed of slide videos showing concepts - a.k.a noCli - and might
and might have videos with command line prompts in between -a.k.a cli). have videos with command line prompts in between - a.k.a cli. All of
All of these videos will then be glued together into the final video these videos will then be glued together into the final video for a
for a certain topic. We are including here an example video, so that certain topic. We are including here an example video, so that you can
you can see everything in action, as well as help us testing if you see everything in action, as well as help us testing if you find a
find a bug. bug.
In addition, videos will be able to be translated to other languges,
so we are taking this into account.
We are adding sections of how the tree structure of the project
might look like, how to create the nonClis, Clis and the final video,
how to clean everything to go on trying, and an example of
how to run several makes to have a final working example video.
If you want to see how to create a nonCli video: please In addition, videos will be able to be translated to other languges,
go to RUNNING MAKE FOR CREATING A VIDEO THAT SHOWS SLIDES so we are taking this into account. We are adding sections of how the
If you want to create a cli video: tree structure of the project might look like, how to create the
RUNNING MAKE FOR CREATING A VIDEO THAT SHOWS CLI nonClis, Clis and the final video, how to clean everything to go on
If you cant to create the final video: RUNNING MAKE FOR CREATING FINAL VIDEO trying, and an example of how to run several makes to have a final
working example video.
If you want to see how to create a nonCli video: please go to RUNNING
MAKE FOR CREATING A VIDEO THAT SHOWS SLIDES. If you want to create a
cli video: RUNNING MAKE FOR CREATING A VIDEO THAT SHOWS CLI. If you
want to create the final video: RUNNING MAKE FOR CREATING FINAL VIDEO
And if you want to know how to work with the translation process: And if you want to know how to work with the translation process:
RUNNING MAKE FOR TRANSLATIONS. RUNNING MAKE FOR TRANSLATIONS.
NOTE FOR TRANSLATIONS: NOTE FOR TRANSLATIONS:
1) Recall copying the .pot files under example/es_AR/pots 1) Recall copying the .pot files under example/es_AR/pots that
that simulate the ones already translated from /example/en_US/pots/ simulate the ones already translated from /example/en_US/pots/.
2) As regards screen script, run it and copy/paste the output 2) As regards screen script, run it and copy/paste the output video
video from en_US locale, since translation of these is under discussion. from en_US locale, since translation of these is under discussion.
3) Copy paste session files from <video>/en_US/sessions/* to 3) Copy paste session files from <video>/en_US/sessions/* to the
the locale's same dir. ie: <video>/es_AR/sessions/. Then run locale's same directory ie <video>/es_AR/sessions/. Then run:
createVideoCli.sh createVideoCli.sh.
NOTE FOR SUBTITLES: NOTE FOR SUBTITLES:
At the moment, the subtitle files worked for the first iteration At the moment, the subtitle files worked for the first iteration of
of the project,when one video was made, so avoid using them. the project,when one video was made, so avoid using them.
* TREE * TREE
The TREE up to now looks like this. audio, svgs, subtitles, pots The TREE up to now looks like this: audio, svgs, subtitles, pots (for
(for other locales rather than en_US) *MUST BE MANUALLY POPULATED*. other locales rather than en_US) *MUST BE MANUALLY POPULATED*.
/ /
|-README |-README
@ -96,18 +99,21 @@ The TREE up to now looks like this. audio, svgs, subtitles, pots
* RUNNING MAKE FOR CREATING A VIDEO THAT SHOWS CLI * RUNNING MAKE FOR CREATING A VIDEO THAT SHOWS CLI
We have created a shell script that automates this process. It calls We have created a shell script that automates this process. It calls
the guile script as well as the a make command, to avoid running them the guile script as well as the a make command, to avoid running them
separately. separately. To create these videos you should run under the root
To create these videos you should run under the root directory: directory:
** ./creacteVideoCli.sh <videoName> <locale> <sessionFilename> ** ./creacteVideoCli.sh <videoName> <locale> <sessionFilename>
<numberOfCLIVideo> <numberOfCLIVideo>
VIDEO=name of the final video ie:example. where:
LOCALE_LANG=locale for which the video is being created.Defaule en_US VIDEO=name of the final video ie example,
NUMBER: number that indicates the order in which the video will be shown. LOCALE_LANG=locale for which the video is being created. Default is
ie: if NUMBER=2 it is the second CLI video that will be included in VIDEO. en_US,
NUMBER=number that indicates the order in which the video will be
shown ie if NUMBER=2 it is the second CLI video that will be included
in VIDEO.
NOTE: all the arguments ARE MANDATORY for now. NOTE: all the arguments ARE MANDATORY for now.
@ -120,14 +126,14 @@ Example: ./createCliVideo.sh example en_US firstCli 1
Example: make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=1 Example: make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=1
Creates a piece of video that shows slides. If omitted, the default video Creates a piece of video that shows slides. If omitted, the default
is used and the locale is considered en_US. video is used and the locale is considered en_US.
IMPORTANT: THE NAME OF THE AUDIO FILE THAT MATCHES EACH SLIDE ***MUST*** IMPORTANT: THE NAME OF THE AUDIO FILE THAT MATCHES EACH SLIDE
BE THE SAME. For instance, if our cond slide video is composed by 4.svg, ***MUST*** BE THE SAME. For instance, if our cond slide video is
5.svg and 6.svg, we will need 4.mp3 5.mp3 5.mp3 files, even our NUMBER composed by 4.svg, 5.svg and 6.svg, we will need 4.mp3 5.mp3 6.mp3
argument is 2, since that means the number of noCLIVideo we are creating, files even if our NUMBER argument is 2, since that means the number of
NOT its files, noCLIVideo we are creating, NOT its files.
* RUNNING MAKE FOR CREATING FINAL VIDEO * RUNNING MAKE FOR CREATING FINAL VIDEO
@ -136,111 +142,110 @@ There are two ways of creating a final video:
** make finalvideo VIDEO=<video> LOCALE_LANG=<locale> ** make finalvideo VIDEO=<video> LOCALE_LANG=<locale>
Creates a the final video with their own audio. Creates the final video with its own audio.
** make finalvideoNoSound VIDEO=<video> LOCALE_LANG=<locale> ** make finalvideoNoSound VIDEO=<video> LOCALE_LANG=<locale>
Creates the same final video similar to the one above but without sound, Creates the same final video similar to the one above but without
four our in progress state. sound, for our in progress state.
* RUNNING MAKE FOR TRANSLATIONS * RUNNING MAKE FOR TRANSLATIONS
** make pots_for_video NUMBER=<numberOfNoCliVideo> ** make pots_for_video NUMBER=<numberOfNoCliVideo>
Creates the .pots only under en_US locale subdir foy the number of Creates the .pots only under en_US locale subdir for the number of
noCli video specified subdir to send them to translators. noCli video specified subdir to send them to translators.
Example: make pots_for_video NUMBER=2 Example: make pots_for_video NUMBER=2
(creates .pot files for nonCli video number 2) (creates .pot files for nonCli video number 2)
* CREATE SVGS FOR BEING ABLE TO RUN LATER MAKE FOR CREATING VIDEOS FOR * CREATE SVGS FOR BEING ABLE TO RUN LATER MAKE FOR CREATING VIDEOS FOR
OTHER LOCALE RATHER THAN en_US OTHER LOCALE RATHER THAN en_US
** make slides VIDEO=<videoName> LOCALE_LANG=<locale> ** make slides VIDEO=<videoName> LOCALE_LANG=<locale>
Creates the translated slides, once the .pot files return from translators, Creates the translated slides, once the .pot files return from
so that they can be used for other locales rather than en_US. translators, so that they can be used for locales other than en_US.
The locale subdir, at least <locale>/slides must be created beforehand. The locale subdir, at least <locale>/slides must be created
LOCALE_LANG is MANDATORY beforehand. LOCALE_LANG is MANDATORY
* RUNNING MAKE CLEAN * RUNNING MAKE CLEAN
** make clean VIDEO=<video> LOCALE_LANG=<locale> ** make clean VIDEO=<video> LOCALE_LANG=<locale>
Cleans all the files related to video creation and translation. Cleans all the files related to video creation and translation. It
It calls all the other clean_* options. calls all the other clean_* options. If VIDEO is not provided, it
If none VIDEO provided, it cleans the DEFAULT, cleans the DEFAULT. If LOCALE_LANG is not provided it cleans en_US.
and if no LOCALE_LANG provided, it cleans en_US.
Example: make clean VIDEO=example LOCALE_LANG=en_US Example: make clean VIDEO=example LOCALE_LANG=en_US
** make clean_noCli VIDEO=<video> LOCALE_LANG=<locale> ** make clean_noCli VIDEO=<video> LOCALE_LANG=<locale>
Cleans all the intermediate videos that do not show CLI commands.. Cleans all the intermediate videos that do not show CLI commands. If
If none VIDEO provided, it cleans the ones that belong to the default video, VIDEO is not provided it cleans the ones that belong to the default
and if no LOCALE_LANG provided, it cleans en_US ones. video. If LOCALE_LANG is not provided it cleans en_US ones.
Example: make clean_noCli VIDEO=example LOCALE_LANG=en_US Example: make clean_noCli VIDEO=example LOCALE_LANG=en_US
** make clean_cli VIDEO=<video> LOCALE_LANG=<locale> ** make clean_cli VIDEO=<video> LOCALE_LANG=<locale>
Cleans all the intermediate videos that do show CLI commands. Cleans all the intermediate videos that do show CLI commands. If
If none VIDEO provided, it cleans the ones that belong to the default video, VIDEO is not provided it cleans the ones that belong to the default
and if no LOCALE_LANG provided, it cleans en_US ones. video. If LOCALE_LANG is not provided it cleans en_US ones.
Example: make clean_cli VIDEO=example LOCALE_LANG=en_US. Example: make clean_cli VIDEO=example LOCALE_LANG=en_US.
** make clean_intermediate_videos VIDEO=<video> LOCALE_LANG=<locale> ** make clean_intermediate_videos VIDEO=<video> LOCALE_LANG=<locale>
Cleans all the intermediate videos, both slides and cli sessions. Cleans all the intermediate videos, both slides and cli sessions. If
If none VIDEO provided, it cleans the ones that belong to the default video, VIDEO is not provided it cleans the ones that belong to the default
and if no LOCALE_LANG provided, it cleans en_US ones. video. If LOCALE_LANG is not provided it cleans en_US ones.
Example: make clean_intermediate_videos VIDEO=example LOCALE_LANG=en_US. Example: make clean_intermediate_videos VIDEO=example LOCALE_LANG=en_US.
** make clean_finalVideo VIDEO=<video> LOCALE_LANG=<locale> ** make clean_finalVideo VIDEO=<video> LOCALE_LANG=<locale>
Cleans the final video, that glues all the intermediate videos, b Cleans the final video, that glues all the intermediate videos, but
ut NOT the INTERMEDIATE ones. NOT the INTERMEDIATE ones. If VIDEO is not provided, it cleans the
If none VIDEO provided, it cleans the one that belong to the default video, one that belong to the default video. If LOCALE_LANG is not provided
and if no LOCALE_LANG provided, it cleans en_US ones. it cleans en_US ones.
** make clean_pots VIDEO=<video> ** make clean_pots VIDEO=<video>
Cleans the .pot files to send to translators for the given video. Cleans the .pot files to send to translators for the given video.
If video not provided, it uses the default one. If VIDEO is not provided it uses the default one.
Example: make clean_pots VIDEO=example Example: make clean_pots VIDEO=example
** make clean_locale_slides VIDEO=<video> LOCALE_LANG=<LOCALE> ** make clean_locale_slides VIDEO=<video> LOCALE_LANG=<LOCALE>
Cleans the translation files - *.po and *.mo inside the en_US subdir Cleans the translation files - *.po and *.mo inside the en_US subdir
for the video ( if VIDEO is not provided, it uses the default one) for the video. If VIDEO is not provided it uses the default one BUT
BUT LOCALE_LANG is *MANDATORY*, if it is not given, make aborts. LOCALE_LANG is *MANDATORY*. If it is not given make aborts.
* EXAMPLE * EXAMPLE
For the example video we have five pieces of video: three nonCli with two For the example video we have five pieces of video: three nonCli with
CLI sessions in between. We have to create them first, to then be able to two cli sessions in between. We have to create them first, to then be
glue them. Run the commands as shown here. able to glue them. Run the commands as shown here:
#First noncli video: #First nonCli video:
make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=1 make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=1
#first CLI video, with audio #First cli video, with audio:
./createCliVideo.sh example en_US firstCli 1 ./createCliVideo.sh example en_US firstCli 1
#second nonCLI video #Second nonCLI video:
make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=2 make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=2
#second CLI video #Second cli video:
./createCliVideo.sh example en_US firstCli 1 ./createCliVideo.sh example en_US firstCli 1
#second noncli video, #Second nonCli video:
make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=3 make videoNoCli VIDEO=example LOCALE_LANG=en_US NUMBER=3
#finally we end up with the final video: #Finally we end up with the final video:
make finalVideo --> output example.webm under /videos subdir. make finalVideo --> output example.webm under /videos subdir.