improve readme more

Author: Noah-Jaffe

README.md

@@ -4,8 +4,7 @@
 - Outputs into a clean .cha file by utterance.
 - As always, TRUST NOTHING GENERATED BY AI, and always verify
 
-## Requirements:
-_If you already have the requirement read through the step to make sure you have it configured properly_
+## Installation:
 1. **Internet** 
     - For installation of the transcriber
     - For the AI model download - on the first time you use a model
@@ -91,6 +90,11 @@ _If you already have the requirement read through the step to make sure you have
         `python --version`
 
 
+1. If on windows and did not select the `"enable symbolic links"` option when installing **GIT**, do the following: 
+    - Enable symbolic links on your machine.
+    - Open the Local group policy editor and add your account user to the following:
+    ![Follow these steps](docs/readme_add_symlinks.png)
+
 1. **The Transcriber**:
     - Now that you have all of the requirements installed we will install the Transcriber from git
         1. Open your choice terminal window
@@ -112,50 +116,52 @@ _If you already have the requirement read through the step to make sure you have
                 - MacOS/Linux
                     - `source ./.venv/bin/activate`
 
-        1. Continue with the [installation process](#how-to-install) steps below
-
-1. If on windows and did not select the `"enable symbolic links"` option when installing **GIT**, do the following: 
-    - Enable symbolic links on your machine.
-    - Open the Local group policy editor and add your account user to the following:
-    ![Follow these steps](docs/readme_add_symlinks.png)
-
+        1. <a id="pip install"></a>`pip install -r requirements.txt`
+            - if the pip install fails try `pip install -r explicit_requirements.txt --no-cache`
+            - if that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcriber/issues)
+            - The only requirements not in the txt files are `torch` `torchaudio` and `torchvision`
+        1. Install requirements not in requirements.txt
+
+            - If you have a CUDA compatible GPU:
+                - [Install CUDA](https://docs.nvidia.com/cuda/cuda-quick-start-guide/) if you have not done so already.
+                - You may need to `pip uninstall torch torchaudio torchvision` before doing this next step.
+                - [Reinstall `torch` `torchaudio` and `torchvision` with your appropriate build](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:
+                - `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.
+
+        1. If you want to make a one click startup script, you could do so now.
+            - Example for windows:
+                Save anywhere as "`Transcribe.ps1`"
+                ```sh
+                cd ~/Documents/Transcriber
+                # if you used a virtual environment uncomment the next line (remove the #)
+                #./venv/Scripts/activate
+                python main.py
+                ```
+            - Example for Mac/Linux
+                Save anywhere as "`Transcribe.sh`"
+                ```
+                #!/bin/bash
+                cd ~/Documents/Transcriber
+                # if you used a virtual environment uncomment the next line (remove the #)
+                # source .venv/bin/activate
+                python main.py
+                ```
+                _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.
+        
 ---
-# How to install:
-1. Install requirements
-    1. <a id="pip install"></a>`pip install -r requirements.txt`
-        - if the pip install fails try `pip install -r explicit_requirements.txt --no-cache`
-        - if that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcriber/issues)
-        - The only requirements not in the txt files are `torch` `torchaudio` and `torchvision`
-    1. If you have a CUDA compatible GPU:
-        - [Install CUDA](https://docs.nvidia.com/cuda/cuda-quick-start-guide/) if you have not done so already.
-        - You may need to `pip uninstall torch torchaudio torchvision` before doing this next step.
-        - [Reinstall `torch` `torchaudio` and `torchvision` with your appropriate build](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`
-    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`. (Note that when you generate the token, you can name it anything and it does not need any special permissions, 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:
-        Save anywhere as "`Transcribe.ps1`"
-        ```sh
-        cd ~/Documents/Transcriber
-        # if you used a virtual environment uncomment the next line (remove the #)
-        #./venv/Scripts/activate
-        python main.py
-        ```
-    - Example for Mac/Linux
-        Save anywhere as "`Transcribe.sh`"
-        ```
-        #!/bin/bash
-        cd ~/Documents/Transcriber
-        # if you used a virtual environment uncomment the next line (remove the #)
-        # source .venv/bin/activate
-        python main.py
-        ```
-        _You may need to run `chmod +x Transcriber.sh` on the new .sh file to give it permissions to execute_
-1. Continue with [using the Transcriber](#using-the-transcriber)
-
-# Using the transcriber
+
+## Using the transcriber
 1. Start the application
     - If using a virtual environment start/activate that now. [See here](#start-activate-venv)
     - Run the program with
@@ -173,7 +179,9 @@ _If you already have the requirement read through the step to make sure you have
 
 
 # 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 not entirely in our control. 
 > `TypeError: '<=' not supported between instances of 'NoneType' and 'float'`
 
@@ -184,6 +192,7 @@ The only known current workaround is to split up the original file into smaller
 _v1.1.0_ is in the works with an automated fix for this
 
 ### How to update my Transcriber app?
+
 If you followed the instructions on this readme file, or installed this repo with git:
 1. Enter the Transcriber directory in the terminal
 `cd Transcriber` or `cd ~/Documents/Transcriber`
@@ -195,13 +204,15 @@ If you followed the instructions on this readme file, or installed this repo wit
 - [Optional] Check the readme, changelog, or release notes to see if there is anything else you need to change.
 
 ### Help, some error occured that is not covered elsewhere!
+
 - Send as much relevant info to the maintainer such as:
     - [ ] the terminal logs
     - [ ] screenshots of what is wrong
     - [ ] explinations for what was expected to happen
     - [ ] .cha file (you can remove sensitive information from the transcripts, but leave the @debug lines)
 
 ### How do I get rid of these ugly @debug lines in my .cha file?
+
 Edit your [transcribe_proc.py](transcribe_proc.py) file to update that the line that is
 `DEBUG_MODE = True`
 to
@@ -211,7 +222,19 @@ to
 
 See function `transcribe_file` in [transcribe_proc.py](transcribe_proc.py). Note that you can ignore the chunks that reference or are dependant on DEBUG.
 
+### Yall got some Morphosyntax?
+In function `transcribe_file` in [transcribe_proc.py](transcribe_proc.py): 
+Uncomment the line inside the `pipeline_activity` variable array:
+```
+        # morphosyntax,
+```
+so that it looks like
+```
+        morphosyntax,
+```
+
 ---
+
 ### Backlog ideas:
 - [ ] Advanced/Runtime configuration of AI parameters?
     - [ ] multiple times or using different models?