docs: update install section of README.md (#344)

* run `poetry lock --no-update`

* fix: update CONTRIBUTING.md

fix typo in 3 words and make pytest code word

* fix: add required dependencies

* add seup.md

* add setup.md

* remove typo

* rename temporarily

* rename to SETUP.md

* update README to include more documentation on

-- when someone should use the install script vs. follow the steps here?

* remove requirements.txt

* add link to installation

* rename typo: prerequisite

* link to start: https://openadapt.ai/#start

* reomve .venv as requirements.txt is no longer used

* update installation instructions

* update the Windows Installtion command (in favour of):

1. https://github.com/OpenAdaptAI/OpenAdaptWeb/pull/30/files#r1252126510
2. https://github.com/OpenAdaptAI/OpenAdaptWeb/pull/30/files#r1252128457

* addressing comment:
#344 (comment)

* address the comment:

#344 (comment)

* address the comment:

https://github.com/OpenAdaptAI/OpenAdapt/pull/344/files#r1252175602

* add .venv to address the comment:

https://github.com/OpenAdaptAI/OpenAdapt/pull/344/files#r1252172932

and

https://github.com/OpenAdaptAI/OpenAdapt/pull/289/files#r1252150636

.gitignore

@@ -5,8 +5,8 @@
 __pycache__
 cache
 *.egg-info
-.venv
 *~
+.venv
 
 # Vim
 *.sw[m-p]
@@ -19,7 +19,7 @@ cache
 .VSCode
 .vsCode
 
-#Idea
+# Idea
 .idea
 
 # Generated performance charts

CONTRIBUTING.md

@@ -28,15 +28,15 @@ from openadapt import models
 In order to effectively communicate any bugs or request new features, please select the appropriate form. If none of the options suit your needs, you can click on "Open a blank issue" located at the bottom.
 
 ## Testing
-[GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) are automatically run on each pull request to ensure consistent behaviour and style. The Actions are composed of PyTest, [black](https://github.com/psf/black) and [flake8](https://flake8.pycqa.org/en/latest/user/index.html).
+[GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) are automatically run on each pull request to ensure consistent behavior and style. The Actions are composed of PyTest, [black](https://github.com/psf/black) and [flake8](https://flake8.pycqa.org/en/latest/user/index.html).
 
-You can run these tests on your own computer by downloading the depencencies in requirements.txt and then running pytest in the root directory. 
+You can run these tests on your own computer by downloading the dependencies using `poetry` (see [here](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/README.md#install)) and then running `pytest` in the root directory. 
 
 ## Pull Request Format
 
 To speed up the review process, please use the provided pull request template and create a draft pull request to get initial feedback. 
 
-The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documenttation.
+The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documentation.
 
 ## Commit Message Format
 

README.md

@@ -32,10 +32,50 @@ The direction is adjacent to [Adept.ai](https://adept.ai/), with some key differ
 3. OpenAdapt works with all types of desktop GUIs, including virtualized (e.g. Citrix) and web
 4. OpenAdapt is open source! (license TBD, please see https://github.com/MLDSAI/OpenAdapt/issues/246)
 
+
 ## Install
 
+<br/>
+
+| Installation Method  |               [Installation Scripts](https://openadapt.ai/#start)                |                               Manual Setup                                |
+|:--------------------:|:--------------------------------------------------------------------------:|:-------------------------------------------------------------------------:|
+|   Recommended for    |                            Non-technical users                             |                              Technical users                              |
+|     Ease of Use      | Streamlines the installation process for users unfamiliar with setup steps | Allows for more control and customization during the installation process |
+
+<br/>
+
+### Installation Scripts
+
+#### Windows
+- Press Windows Key, type "powershell", and press Enter
+- Copy and paste the following command into the terminal, and press Enter (If Prompted for `User Account Control`, click 'Yes'):
+  <pre className="whitespace-pre-wrap code text-slate-600 bg-slate-100 p-3 m-2">
+   Start-Process powershell -Verb RunAs -ArgumentList '-NoExit', '-ExecutionPolicy', 'Bypass', '-Command', "iwr -UseBasicParsing -Uri 'https://raw.githubusercontent.com/MLDSAI/OpenAdapt/main/install/install_openadapt.ps1' | Invoke-Expression"
+  </pre>
+
+#### MacOS
+- Download and install Git and Python 3.10
+- Press Command+Space, type "terminal", and press Enter
+- Copy and paste the following command into the terminal, and press Enter:
+  <pre className="whitespace-pre-wrap code text-slate-600 bg-slate-100 p-3 m-2">
+   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/OpenAdaptAI/OpenAdapt/HEAD/install/install_openadapt.sh)"
+  </pre>
+
+<br/>
+<br/>
+
+### Manual Setup
+
+Prerequisite:
+- Python 3.10
+- Git
+- Tesseract (for OCR)
 
-Install with [Poetry](https://python-poetry.org/) (recommended):
+For the setup of any/all of the above dependencies, follow the steps [SETUP.md](./SETUP.md).
+
+<br/>
+
+Install with [Poetry](https://python-poetry.org/) :
 ```
 git clone https://github.com/MLDSAI/OpenAdapt.git
 cd OpenAdapt
@@ -46,19 +86,6 @@ alembic upgrade head
 pytest
 ```
 
-Manual:
-```
-git clone https://github.com/MLDSAI/OpenAdapt.git
-cd OpenAdapt
-python3.10 -m venv .venv
-source .venv/bin/activate
-pip install wheel
-pip install -r requirements.txt
-pip install -e .
-python -m spacy download en_core_web_trf
-alembic upgrade head
-pytest
-```
 
 ## Permissions
 

SETUP.md

@@ -0,0 +1,56 @@
+# Setup Instructions for the following:
+
+1. Python 3.10
+2. Git
+3. Tesseract (for OCR)
+
+
+
+## Python 3.10
+
+#### Windows:
+- Download the Python 3.10 Binary File: https://www.python.org/ftp/python/3.10.0/python-3.10.0-amd64.exe
+- Follow the steps for Installation here: https://www.digitalocean.com/community/tutorials/install-python-windows-10
+
+
+#### macOS:
+- Download the Python 3.10 Package Installer: https://www.python.org/ftp/python/3.10.11/python-3.10.11-macos11.pkg
+- Follow the steps for Installation here: https://www.codingforentrepreneurs.com/guides/install-python-on-macos/
+
+
+#### Ubuntu
+- Open Terminal and type the following command:
+  - `sudo apt install python3.10-full`
+
+
+
+
+## Git
+
+#### Windows:
+- Download system appropriate binary (exe) file from here: https://git-scm.com/download/win
+- Install the setup file.
+
+
+#### macOS:
+- Follow the steps here: https://git-scm.com/download/mac
+
+
+#### Ubuntu (Linux and Unix):
+- Follow the steps here: https://git-scm.com/download/linux
+
+
+
+
+## Tesseract OCR
+
+#### Windows:
+- Download the following binary (.exe) file:
+    [Tesseract Setup](https://digi.bib.uni-mannheim.de/tesseract/tesseract-ocr-w64-setup-5.3.1.20230401.exe)
+- Run the downloaded file to install Tesseract OCR
+- Add Tesseract to User and System PATH variable.
+    - See Step 5 and 6 in https://linuxhint.com/install-tesseract-windows/
+
+
+#### macOS, Ubuntu and Other Operating System:
+- Follow the OS Specific installation here: https://tesseract-ocr.github.io/tessdoc/Installation.html