Merge branch 'master' of github.com:bbc/digital-paper-edit-electron

docs/guides/user-instructions.md

@@ -1,58 +1,85 @@
 # User Instructions - Draft
+
 Here are some instructions for using a packaged version of the app for desktop, (we still have to draft a user manual for this tool so if anything is not clear let us know so that we can feed it back into it)
 
+You can download the pre release from [this link](https://github.com/bbc/digital-paper-edit-electron/releases).
 
-You can download the pre release from this link
+![Github Releases](./github_dmg.png)
 
-https://github.com/bbc/digital-paper-edit-electron/releases
+## Installation
 
+### Mac
 
-1. Click on ‘assets’ and choose the first one that ends with `.dmg``
-2. Once you have downloaded the app you need to open the `.dmg` file
-3.  Drag the app into the applications folder 
-3.  In the applications folder, then right click on the app and click open 
-4. Once the app as launched in the top bar ( the one with the Apple logo) you should see an option that says ‘speech to text settings’ click on that and then on ‘edit speech to text configuration’.
+1. Click `Assets` on the version you would like (the newest one is at the top)
+2. Click the `digital-paper-edit-electron-<version>.dmg` to download the `dmg` file
+3. Once downloaded, double click and open the `dmg` file
+4. Drag the app into the applications folder
 
-A new window should come up where you can set default speech to text service and language, as well as adding the credentials for the service to use for generating transcriptions.
+The app comes with two example projects, to make it easier to try it out and evaluate on first use.
 
-As a side note at the moment the option is between Speechmatics and AssemblyAI.
-https://www.speechmatics.com/
-https://www.assemblyai.com/
-AssemblyAI gives you 5 hours of free trial a months, while Speechmatics only 30 min as a one of.
-Speechmatics supports multiple languages while assemblyAI is only in English.
+## Options
 
-5. Once you have decided which STT you’d like to use and you have made an account and got the API credentials from their dashboards you can add those to the setting view.
+## Speech-to-text (STT) Settings
 
-Before closing the settings window make sure you have selected a default for speech to text provider and language ( and clicked save) as well as added the credentials for that provider ( and clicked saved)
+1. Launch the app `digital-paper-edit-electron` in the applications folder
+2. Click on the `Speech To Text Settings` in the menu at the top
+3. Select `Edit Speech To Text Configuration`.
+4. Once the STT configuration window is opened, select default STT provider and language and click save
+5. Enter API credentials from STT provider's dashboard (see links below) and click save
 
-You can now go back to the main window.
+Current STT Providers:
 
-The app comes with two example projects, to make it easier to try it out and evaluate on first use.
+- [Speechmatics](https://www.speechmatics.com/)
+- [AssemblyAI](https://www.assemblyai.com/).
+
+### [Speechmatics](https://www.speechmatics.com/)
+
+Free tier: 30 minutes
+Supports: Multiple languages
+
+### [AssemblyAI](https://www.assemblyai.com/)
+
+Free tier: 1 month
+Supports: English
+
+## Creating a project
+
+In the main window you can create a project (to group your transcripts and paper edits)
 
-6. In the main window you can create a project ( to group your transcripts and paper edits )
+## Transcribing Audio / Video
 
-7. Once you have done that you can create a transcript and get some audio or video file transcribed.
-( at a later stage I might do some optimization so that it could take 5 minutes regardless of how long the media is, by chunking and sending in parallel but not now the speed of the Transcription is dependent on the provider, generally a little less then real-time, assemblyAI might be slightly faster then Speechmatics but not sure)
+Once a project is created, you can create a transcript and get some audio or video file transcribed.
 
-If you click on the transcript when is ready It is possible to correct the transcript using the editor ( but at the moment this function is not fully integrated with the rest of the system, so would recommend skipping it for now until it is)
+Note: At a later stage I might do some optimization so that it could take 5 minutes regardless of how long the media is, by chunking and sending in parallel but not now the speed of the Transcription is dependent on the provider, generally a little less then real-time, assemblyAI might be slightly faster then Speechmatics but not sure.
 
-8. Once you have a transcripts you can create a programme script ( a paper edit)
+## Editing Transcripts
 
-9. In the programme script/ paper edit view, you also get access to the transcripts for the project.
+If you click on the transcript when it's ready, It is possible to correct the transcript using the editor (but at the moment this function is not fully integrated with the rest of the system, so would recommend skipping it for now until it is)
 
-You can highlight and annotare, as well as create custom labels.
+## Creating a programme script (paper edit)
 
-You can also search and filter ( at the moment with a transcript but in the future across transcripts in a project)
+Once you have a transcript you can create a programme script (paper edit).
+Int he programme script / paper edit view you can:
 
-10. In this view where you have transcripts on the left and programme script on the right you can select some text in a transcript and add it to the programme script on the left. By clicking the + button.
+* access project's transcripts
+* highlight and annotate
+* create custom labels
+* search and filter ( at the moment with a transcript but in the future across transcripts in a project)
 
-It’s possible to rearrange text snippets in the programme script as well as delete.
+## Editing the programme script
 
-And you can generate a preview to see how it would flow.
+In the programme script view you have transcripts on the left and programme script on the right.
+You can add selected text from the transcript to the programme script by clicking the + button.
+It's possible to rearrange or delete text snippets in the programme script.
+You can also generate a preview.
 
-11. When you are done there is an export btn in the programme script, to export for Premiere choose EDL, it stands for edit decision list, you can open it in Premiere as a sequence. 
+## Exporting the programme script
 
-The clips will be offline, you can then reconnect them in Premiere to continue your edit.
+When you are done there is an export button in the programme script.
 
+### Adobe Premiere
+To export to Premiere, choose EDL (edit decision list).
+Once it's exported you can import the EDL in Premiere as a sequence.
+The clips will be offline. To continue editing, you will need to manually reconnect the files in Premiere.
 
-<!-- Hope this is not too detailed, and that is easy to follow. Let me know how you get on and if you got any questions  -->
+<!-- Hope this is not too detailed, and that is easy to follow. Let me know how you get on and if you have any questions  -->