update readme for instructions of use

Author: Devin-Cook

README.md

@@ -18,23 +18,6 @@
 </p>
 
 <p align="center">
-<!--[[[cog
-from scripts.badges import get_badges_md
-text = get_badges_md()
-cog.out(text)
-]]]-->
-  <a href="https://github.com/Aider-AI/aider/stargazers"><img alt="GitHub Stars" title="Total number of GitHub stars the Aider project has received"
-src="https://img.shields.io/github/stars/Aider-AI/aider?style=flat-square&logo=github&color=f1c40f&labelColor=555555"/></a>
-  <a href="https://pypi.org/project/aider-chat/"><img alt="PyPI Downloads" title="Total number of installations via pip from PyPI"
-src="https://img.shields.io/badge/📦%20Installs-1.7M-2ecc71?style=flat-square&labelColor=555555"/></a>
-  <img alt="Tokens per week" title="Number of tokens processed weekly by Aider users"
-src="https://img.shields.io/badge/📈%20Tokens%2Fweek-15B-3498db?style=flat-square&labelColor=555555"/>
-  <a href="https://openrouter.ai/"><img alt="OpenRouter Ranking" title="Aider's ranking among applications on the OpenRouter platform"
-src="https://img.shields.io/badge/🏆%20OpenRouter-Top%2020-9b59b6?style=flat-square&labelColor=555555"/></a>
-  <a href="https://aider.chat/HISTORY.html"><img alt="Singularity" title="Percentage of the new code in Aider's last release written by Aider itself"
-src="https://img.shields.io/badge/🔄%20Singularity-92%25-e74c3c?style=flat-square&labelColor=555555"/></a>
-<!--[[[end]]]-->
-</p>
 
 ## Why explORE-AI?
 
@@ -52,30 +35,73 @@ We owe a **huge thanks** to [Aider](https://github.com/Aider-AI/aider) for provi
 
 - 🏦 **ORE-Specific Insights** — **explORE-AI** can reference and analyze ORE’s specific code structure, giving more precise guidance.
 - 🗺️ **Codebase Mapping** — Just like Aider, but with a deeper understanding of the ORE ecosystem.
-- 🧠 **[Cloud and Local LLMs](https://aider.chat/docs/llms.html)** — Choose from Claude, DeepSeek, GPT variants, or almost any other LLM.
-- `</>` **[Multi-Language Support](https://aider.chat/docs/languages.html)** — Even though ORE is mostly C++, explORE-AI supports 100+ coding languages.
-- 🔀 **[Git Integration](https://aider.chat/docs/git.html)** — Automatic commits with sensible messages, so you can track AI-generated changes effortlessly.
-- 🏗️ **Domain-Specific Testing & Linting** — Integrates smoothly with ORE’s tests or any specialized linters to ensure high-quality code.
-- 🗣️ **Voice-to-Code** — Request new features, bug fixes, or run analytics queries by voice.
-- 📋 **[Copy/Paste Web Chat](https://aider.chat/docs/usage/copypaste.html)** — If you need to jump into a browser-based LLM environment, explORE-AI makes it easier.
+- 🧠 **[Cloud and Local LLMs](https://aider.chat/docs/llms.html)** — explORE-AI is mainly developed and tested with GPT variants, however other models supported by aider may work.
+
+
+# Getting Started with explORE-AI
+
+Follow the instructions below to clone, install, and use explORE-AI effectively.
+
+## Directory Structure
+
+Ensure your directory is structured correctly for explORE-AI to function properly:
+
+```
+root/
+├── Engine/
+└── explORE-AI/
+```
 
-## Getting Started
+This layout enables explORE-AI to locate the ORE directory correctly.
+
+## Cloning the Repository
+
+Clone the explORE-AI repository into the **root** directory using the following command:
 
 ```bash
-# 1. Clone this explORE-AI repository
 git clone https://github.com/Devin-Cook/explORE-AI.git
+```
+
+## Installation
+
+Navigate to your `root` directory (containing both the `Engine` and `explORE-AI` directories) and install explORE-AI by running:
+
+```bash
+python -m pip install ./explORE-AI
+```
 
-# 2. Install
-python -m pip install ./explore-ai
+## Usage
 
-# 3. Navigate to your ORE codebase
-cd /path/to/OpenSourceRiskEngine
+After installation, you can interact with explORE-AI in several ways:
 
-# 4. Launch explORE-AI with your preferred model:
-aider --model deepseek --api-key deepseek=<key>
+### 1. Command-Line Interaction
+
+To start the chat via command-line mode, use:
+
+```bash
+explore-ai --openai-api-key=OPENAPI_KEY
+```
+
+Replace `OPENAPI_KEY` with your actual OpenAI API key.
+
+### 2. GUI Mode
+
+To launch the graphical user interface (GUI) via Streamlit, execute:
+
+```bash
+explore-ai --openai-api-key=OPENAPI_KEY --gui
+```
+
+### 3. GUI with Userguide Materials
+
+To initialize the GUI along with the Userguide materials, run:
+
+```bash
+explore-ai --openai-api-key=OPENAPI_KEY --userguide
+```
 
-# Example for Claude:
-aider --model sonnet --api-key anthropic=<key>
+## Additional Notes
 
-# Example for o3-mini:
-aider --model o3-mini --api-key openai=<key>
+- Ensure you are in the `root` directory containing both `Engine` and `explORE-AI` when running installation and other commands.
+- Verify the validity of your OpenAI API key.
+- If you encounter any issues, confirm your directory structure and dependencies installation.