Issue#2/setup instructions

README.md

@@ -12,9 +12,9 @@
 
 **AI Powered OCR Code Recognition from Video Tutorials**
 
-[![Build](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/build.yml)
-[![Tests](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/actions/workflows/tests.yml)
-[![Accessibility](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-project-ocrroo/actions/workflows/accesibility.yml)
+[![Build](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/build.yml)
+[![Tests](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/tests.yml)
+[![Accessibility](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml/badge.svg)](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/actions/workflows/accesibility.yml)
 
 </div>
 
@@ -23,7 +23,7 @@
 A video player designed to assist visually impaired developers who want to learn to code.
 The program reads code from videos to assist visually impaired developers in using these resources.
 
-## Features - (need more info)
+## Features - (need more info) TODO
 
 ---
 
@@ -34,50 +34,109 @@ The program reads code from videos to assist visually impaired developers in usi
 
 ## Installation
 
-To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Installation-Guide)
-in the [Wiki](https://github.com/NM-TAFE/dip-project-ocrroo/wiki).
+To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Installation-Guide)
+in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki).
 
 #### Basic Installation
 
 1. Navigate to the projects root folder
 
+   ```bash
+   cd dip-programming-prj-advanced-gui-architect/
+   ```
+
 2. Create a virtual environment
 
-```bash
-python -m venv ./venv
-```
+   Windows
+
+   ```bash
+   python -m venv ./venv # create virtual environment
+   ./venv/Scripts/activate # activate virtual
+   ```
+
+   Linux / Mac OS X
+
+   ```bash
+   python3 -m venv./venv # create virtual environment
+   source venv/bin/activate # activate virtual
+   ```
 
 3. Activate the virtual environment
    Windows:
 
-```bash
-./venv/Scripts/activate
-```
+   ```bash
+   ./venv/Scripts/activate
+   ```
 
-Mac/Linux
+   Mac/Linux
 
-```bash
-source venv/bin/activate
-```
+   ```bash
+   source venv/bin/activate
+   ```
 
 4. Install dependencies with pip
 
-```bash
-pip install -r requirements.txt
-```
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+5. Run the Application
+
+To run the application with silenced debug/logging output, execute the following command. Debug and logging outputs will be saved to an `app.log` file
+
+   ```bash
+   python app/app.py
+   ```
+
+## Additional Configuration
+
+1. This project requires the Tesseract OCR Library (note: may require an installer).
+
+   Tesseract OCR Documentation: https://tesseract-ocr.github.io/tessdoc/Installation.html
+
+   Windows Installer: https://github.com/UB-Mannheim/tesseract/wiki
+
+   WARNING: Tesseract should be either installed in the directory which is suggested during the installation or in a 
+   new directory. The uninstaller removes the whole installation directory. If you installed Tesseract in an existing 
+   directory, that directory will be removed with all its subdirectories and files.
+
+2. The project currently requires an API Key for OpenAI.
+
+   OpenAI API: https://openai.com/index/openai-api/
+
+3. This project requires the PATH to your IDE executable. 
+
+Update the above configuration variables into the below file:
+
+   ```bash
+   app/config.ini
+   ```
+
+## Running the Project
+
+1. Once the Installation and Configuration steps have been completed; navigate and run:
+   ```bash
+   python app/app.py
+   ```
+
+To run the application with debug/logging output in the console, use the following command.This is recommended for development as it automatically reloads the app when changes are detected.
+
+   ```bash
+   flask run --debug
+   ```
 
-5. ...rest of installation steps here
+2. The terminal will display the localhost link for the project in the console.
 
 ## Contributing
 
-To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/wiki/Contribution-Guide)
-in the [Wiki](https://github.com/NM-TAFE/dip-project-ocrroo/wiki).
+To contribute to this project, please follow the [Contribution Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki/Contributor's-Guide)
+in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki).
 
 ## Code of Conduct
 
 ---
 
-- To view the code of conduct, please visit the [Code of Conduct] page in the [Wiki](https://github.com/NM-TAFE/project-advanced-ui-development-team-mental-capacity/wiki).
+- To view the code of conduct, please visit the [Code of Conduct] page in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-architect/wiki).
 
 ## License