update readme and requirements bump

Author: Noah-Jaffe

README.md

@@ -5,6 +5,15 @@
 - Outputs into a clean .cha file by utterance.
 - As always, TRUST NOTHING GENERATED BY AI, and always verify
 
+## REQUIREMENTS:
+*See the [installation](#installation) section for detailed step by step instructions.*
+1. Internet (for install and download of AI models to be run locally)
+1. FFMPEG (should be available via environment PATH)
+1. GIT (should be available via environment PATH)
+1. PYTHON 3.11+ (should be available via environment PATH)
+1. Huggingface key/account (for download of AI models to be run locally)
+1. _[Optional]_ CUDA (requires NVIDIA GPUs, for faster runtime)
+
 ## Installation:
 1. **Internet** 
     - For installation of the transcriber
@@ -46,7 +55,8 @@
         `git --version`
         If you don’t have it installed already, it should prompt you to install it. If it does not, see the detailed guide on installing git above.
     - Windows:
-        - Install git for windows from the offical git website: [https://git-scm.com/downloads/win](https://git-scm.com/downloads/win)
+        - Automatic install with command line: `winget install -e --id Git.Git`
+        - Or manual install git for windows from the offical git website: [https://git-scm.com/downloads/win](https://git-scm.com/downloads/win)
             - Click on the first install link. It should look like the following
                 > Click here to download the latest (##.##.##) x64 version of Git for Windows.
             - When installing, use the default configuration for all steps except:
@@ -67,21 +77,22 @@
     - MacOS: install ffmpeg to be made available by the command line
         - `brew install ffmpeg`
     - Windows:
-        - Install here [instant download link to zip file](https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-win64-gpl-shared.zip) or follow the instructions on the offical ffmpeg webiste here [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html).
-        - If you downloaded a zip file follow these steps:
-            - Unzip (or move the unzipped files) to `C:/Program Files/ffmpeg`
-                The results should look like the following:
-                ![example](docs/ffmpeg_install_windows_manual.png)
-            - Add the `C:/Program Files/ffmpeg/bin` (or wherever you downloaded it to + `/bin`) to your system environment PATH variable
-                - in windows bar search, type "`env`" and follow the arrows in the image below
-                - when you click "new" enter `C:\Program Files\ffmpeg\bin`. DO NOT EDIT ANY OTHER LINE THAT IS ALREADY THERE!
-                ![example](docs/update_system_env_path.png)
+        - Automatic install with command line: `winget install ffmpeg`
+        - OR manual install here [instant download link to zip file](https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-win64-gpl-shared.zip) or follow the instructions on the offical ffmpeg webiste here [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html).
+            - If you installed manually, follow these steps:
+                - Unzip (or move the unzipped files) to `C:/Program Files/ffmpeg`
+                    The results should look like the following:
+                    ![example](docs/ffmpeg_install_windows_manual.png)
+                - Add the `C:/Program Files/ffmpeg/bin` (or wherever you downloaded it to + `/bin`) to your system environment PATH variable
+                    - in windows bar search, type "`env`" and follow the arrows in the image below
+                    - when you click "new" enter `C:\Program Files\ffmpeg\bin`. DO NOT EDIT ANY OTHER LINE THAT IS ALREADY THERE!
+                    ![example](docs/update_system_env_path.png)
 
 1. **CUDA**
     - If you can, use CUDA to increase performance when running the AI.
-    - __NOTE: You will probably need a NVIDIA GPU for this.__
+    - __NOTE: You will need a NVIDIA GPU for this.__
     - [Install CUDA](https://docs.nvidia.com/cuda/cuda-quick-start-guide/)
-    - If this sounds like gibberish to you, it is safe to skip this step. Your AI models will run off of just your CPU.
+    - If this sounds like gibberish to you, it is safe to skip this step. Your AI models will run off of your CPU.
 
 1. **Python's tkinter** needs to be installed
     - If you installed python with the installer and selected the tk/tcl and IDLE options, you should have this step completed already.
@@ -118,25 +129,25 @@ Now that you have all of the requirements installed we will install the Transcri
             - MacOS/Linux
                 - `source ./.venv/bin/activate`
 
-    1. <a id="pip install"></a>`pip install -r requirements.txt`
-        - if the pip install fails try installing each package one at a time, by line as it is written in the requirements.txt file.
-        - if that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcribble/issues)
-        - The only requirements not in the txt files are `torch` `torchaudio` and `torchvision`
-    1. Install requirements not in requirements.txt
+    1. Install python packages with the command: <a id="pip install"></a>`pip install -r requirements.txt`
+        - If the pip install fails try installing each package one at a time, by line as it is written in the [requirements.txt](requirements.txt) file.
+        - If that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcribble/issues)
+        - The only requirements not in the txt files are `torch` `torchaudio` and `torchvision` (continue reading...)
+    1. Install requirements not in the requirements.txt
 
-        - If you are using CUDA:
+        1. **If you are using CUDA**:
             - You may need to `pip uninstall torch torchaudio torchvision` before doing this next step.
             - See here to reinstall `torch` `torchaudio` and `torchvision` with your appropriate build: [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
                 - Example for if you have a CUDA compatible device for 12.6 you would run: `pip install torch torchvision torchaudio --no-cache -U --index-url https://download.pytorch.org/whl/cu126`
-        - Otherwise if you dont have a CUDA compatible GPU or dont know what that means then run the next line:
+        1. **Otherwise if you dont have a CUDA compatible GPU or dont know what that means then run the next line**:
             - `pip install torch torchaudio torchvision`
     1. Put your [Huggingface token](https://huggingface.co/docs/hub/en/security-tokens) in a file named `.hftoken`.
         - `.hftoken` only, `.hftoken.txt` will not work
             ![Your directory should look something like this](docs/hftoken.png)
         - Generating the token:
-            - You may need to create an account, you can skip all the optional steps except for verifying your email.
-            - You can name the token anything, just save the token to a file called `.hftoken` to your machine.
-            - The token does not need any special permissions, you can deselect all of the options.
+            - You may need to [create a huggingface account](https://huggingface.co/join), you can skip all the optional steps except for verifying your email.
+            - You can name the token anything on the setup page, just save the resulting token to a file called `.hftoken` to your machine.
+            - When asked to setup the token permissions, please note that the token does not need any special permissions and *you can deselect **all*** of the options.
 
     1. If you want to make a one click startup script, you could do so now.
         - Example for windows:
@@ -158,11 +169,11 @@ Now that you have all of the requirements installed we will install the Transcri
             ```
             _You may need to run `chmod +x Transcriber.sh` on the new .sh file to give it permissions to execute_
         - _NOTE: You might need to do some additional research for how to do this properly for your machine._
-1. Continue to the [using the transcriber](#using-the-transcriber) step.
+1. Continue to the [using Transcribble](#using-transcribble) step.
 
 ---
 
-## Using the transcriber
+## Using Transcribble
 1. Start the application
     - If using a virtual environment start/activate that now. [See here](#start-activate-venv)
     - Run the program with
@@ -185,25 +196,10 @@ Please see the [CITATION](CITATION.cff) file for citing this work.
 
 > Jaffe, N., & Lurie, S. (2025). *Jaffe-Lurie Transcribble* [Computer software]. GitHub. https://github.com/Noah-Jaffe/Transcribble
 
+---
 
 # Frequently asked questions:
 
-### Help, I got a `TypeError: ... not supported between instances of 'NoneType' and 'float'`!
-
-If you run into the following errors specifically in the Whisper (Step 1), know that this is an error of the AI and may not entirely be in our control.
-> `TypeError: '<=' not supported between instances of 'NoneType' and 'float'`
-
-> `TypeError: '>' not supported between instances of 'NoneType' and 'float'`
-
-One patch for this is to use python package `transformers==4.38.2`.
-
-To attempt patch #1:
-- If using a virtual environment start/activate that now. [See here](#start-activate-venv)
-- Run `pip install transformers==4.38.2`
-
-If you are already using this version of transformers, I'm sorry but the only known workaround is to split up the original file into smaller segments, and then run the smaller segments through the transcriber again. Eventually you may hit a small section of the original audio file that crashes constantly, for that you will have to transcribe by hand.
-
-
 ### How to update my Transcribble app?
 
 If you followed the instructions on this readme file, or installed this repo with git:
@@ -243,6 +239,38 @@ so that it looks like
         morphosyntax,
 ```
 
+### How do I use this in more fine detail?
+
+See the `__doc__` in the [transcribe_proc.py](transcribe_proc.py) file.
+
+### I want to split a file into files of smaller (but relatively equal length) chunks!
+
+Run `python splitfile.py`
+1. Select the files to be split
+2. Input the number of seperations and the seconds of overlap between each split file
+3. Click split file
+4. Find the output files next to the input files as `<file_name>.#.<ext>`
+    - e.g. Input file `myfile.mp3` split into 2 files will result in files: `myfile.1.mp3` `myfile.2.mp3` (the original file will not be changed or moved)
+
+
+### Help, I got a `TypeError: ... not supported between instances of 'NoneType' and 'float'`!
+
+If you run into the following errors specifically in the Whisper (Step 1), know that this is an error of the AI and may not entirely be in our control.
+> `TypeError: '<=' not supported between instances of 'NoneType' and 'float'`
+
+> `TypeError: '>' not supported between instances of 'NoneType' and 'float'`
+
+One patch for this is to use python package `transformers==4.38.2`.
+
+To attempt patch #1:
+- If using a virtual environment start/activate that now. [See here](#start-activate-venv)
+- Run `pip install transformers==4.38.2`
+
+If you are already using this version of transformers, I'm sorry but the only known workaround is to split up the original file into smaller segments, and then run the smaller segments through the transcriber again. Eventually you may hit a small section of the original audio file that crashes constantly, for that you will have to transcribe by hand.
+
+Note that this issue should be fixed as of Transcribble release 1.1.1!
+
+
 ---
 
 ### Backlog ideas:
@@ -253,5 +281,6 @@ so that it looks like
 - [ ] Select subframe of time to transcribe from?
 - [ ] Better error handling
 - [ ] Checkboxes for pipeline steps?
-
-
+- [ ] Research Inter-sentential code-switching
+- [ ] Custom setup for auto run script on output .cha file?
+- [ ] Remove reliance on batchalign?