updating the documentation

README.md

@@ -1,71 +1,74 @@
+
 # ImSwitch Installer
 
-![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge) ![Electron.js](https://img.shields.io/badge/Electron-191970?style=for-the-badge&logo=Electron&logoColor=white) ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) ![Mac OS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+![License](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge) ![Electron.js](https://img.shields.io/badge/Electron-191970?style=for-the-badge&logo=Electron&logoColor=white) ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) ![Mac OS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0) ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
 
-# Debugging 
+## Introduction
 
-## Python
+The ImSwitch Installer is an Electron-based application designed to streamline the installation process of the ImSwitch environment. It automates the download and setup of a Mamba environment along with all necessary dependencies from GitHub via pip. This tool simplifies the installation process, reducing it to a few clicks and eliminating the need for executing multiple complex commands.
 
-### Windows 
+## Features
 
-It installs Mambaforge into the following folder,
-```
-C:\Users\UCadmin2\ImSwitch\miniforge\condabin
-```
+- **Easy Installation:** Downloads and installs all necessary dependencies automatically.
+- **Cross-Platform Support:** Available for ARM64 and Intel-based Mac, Windows, and Linux systems.
+- **Simple Uninstallation:** Remove by deleting the ImSwitch folder.
+- **Security:** Instructions provided for bypassing system security warnings due to unsigned code.
+- **Update Mechanism:** Integrated update functionality to easily fetch the latest versions.
 
-The python executable:
-```
-C:\\Users\\UCadmin2\\ImSwitch\\miniforge\\python.exe
-```
+## Requirements
 
-The ImSwitch package location
-```
-C:\\Users\\UCadmin2\\ImSwitch\\miniforge\\lib\\site-packages\\imswitch\\__init__.py'
-```
+- **Disk Space:** Minimum of 5GB.
+- **Memory:** 8GB RAM.
+- **Processor:** Intel i5 or Apple Silicon.
+
+## Installation Guide
 
+1. **Download the Installer:** Choose the appropriate installer (ARM64 for Mac, Windows) from the [releases section](https://github.com/openUC2/ImSwitchInstaller/releases/).
+2. **Run the Installer:** Double-click the downloaded file. Ignore any security warnings as the installer is not yet signed.
+   - For macOS, follow [Apple's guide](https://support.apple.com/en-us/HT202491) for running unsigned code.
+   - On Windows, grant permission to run the application.
+3. **Installation Process:** The installer will set up a Python environment using Mamba in `/User/yourname/ImSwitch` and install all dependencies. This process may take between 10 to 30 minutes depending on your internet connection.
+4. **Starting ImSwitch:** Once installed, launch ImSwitch by executing `start imswitch`.
 
-# Introduction
-*TBA*
+![Installation Screen 1](./assets/Screen1.png)
+![Installation Screen 2](./assets/Screen2.png)
 
-# Compatability
-*TBA*
+## Updating ImSwitch
 
-# Usage
-*TBA*
+To update, click the update button within the application. This will download the latest ZIP from GitHub, unzip it, and execute `pip install -e .` within the Mamba base environment.
 
-# Requirements
+## Driver Installation
 
-- At least 20GB of disk space
-- 32GB of memory
-- Intel i5 / Apple Silicon / AMD Ryzen 4th gen
-- (Strongly Recommended) GPU with at least 6 GB of VRAM
+Drivers for Daheng and HIK Vision cameras can be found under the "Driver Installation" link provided within the installer.
 
-# Install from Release
+## Upcoming Features
 
-Get a percompiled version from releases, download the most recent version for your OS.
-To run simply extract the downloaded release and run the belljar executable.
+- Flashing the latest version of the UC2 firmware.
+- Building the ImSwitch Hardware Configuration using a drag-and-drop GUI.
 
-Note: On some OSX systems you'll need to authroize the Bell Jar process to run since code signing is not implemented.
-See Apple's guide on running unsigned code, https://support.apple.com/en-us/HT202491.
+## Install from Source
 
-Tip: Releases are also found under tags on github.
+For those interested in building from source:
 
-# Install from Source
+```bash
+# Clone the repository
+git clone https://github.com/openuc2/imswitchinstaller.git
 
-To build and run from source please clone the main branch onto your local machine and run the following. Note that complete install requires internet and is about 20gb on disk.
+# Install dependencies (skip if you already have yarn)
+npm install
 
+# Run the Electron app
+npm start
 ```
-// 1. Clone the main branch of the repository
-git clone https://github.com/asoronow/belljar.git
 
-// 2. If you do not have yarn, other wise skip to step 3
-// Install node.js and npm if you do not have them (https://nodejs.org/en/download) then run
-npm install -g yarn
+## Debugging
 
-// 3. Install all dependencies
-// navigate to the cloned directory in your terminal and run
-yarn install
+### Python Environment Locations
 
-// 4. Run the Electron app to use Bell Jar
-yarn start
-```
+- **Windows Installation Path:** `C:\Users\UCadmin2\ImSwitch\miniforge\condabin`
+- **Python Executable:** `C:\\Users\\UCadmin2\\ImSwitch\\miniforge\\python.exe`
+- **ImSwitch Package Location:** `C:\\Users\\UCadmin2\\ImSwitch\\miniforge\\lib\\site-packages\\imswitch\\__init__.py'`
+
+# Disclaimer
+
+This installer is based on the BellJar project. Thanks a lot for making it open-source! :)