From 1ebe362c9cb06036365bed6eb182bd70f6fac217 Mon Sep 17 00:00:00 2001
From: mscrnt <trunksGT243@gmail.com>
Date: Tue, 20 May 2025 07:15:18 -0700
Subject: [PATCH] Add README.md with project description, features, and usage
 instructions

---
 README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/README.md b/README.md
index e69de29..c99e2cd 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,92 @@
+<p align="center">
+  <img src="logo.png" alt="Agent M Logo" width="200"/>
+</p>
+
+<h1 align="center">🕹️ Agent M</h1>
+<h3 align="center">A DIAMBRA Utility by mscrnt</h3>
+
+---
+
+**Agent M** is a retro-styled launcher for [DIAMBRA Arena](https://www.diambra.ai/), designed to make agent training and packaging effortless. It wraps the official `diambra` CLI with a powerful terminal UI (TUI) powered by [Textual](https://textual.textualize.io/), giving both beginners and power users a guided experience for environment setup, wrapper configuration, and agent submission.
+
+---
+
+## 🚀 Features
+
+- 📦 **Project scaffolding**: Quickly generate ready-to-train agent folders
+- 🎮 **Environment launcher**: Easily configure and run DIAMBRA games
+- 🧠 **Training config wizard**: Guide users through wrappers, hyperparameters, and PPO settings
+- 📊 **Evaluation screen**: Run saved agents interactively
+- 🛠️ **Docker + submission helper**: Build, tag, and submit your agent
+- 🔒 **Developer ID tracking**: All submissions include a unique developer ID (`mscrnt-0001`)
+
+---
+
+## 📁 Folder Structure
+
+```text
+agentm/
+├── agentm/
+│   ├── __init__.py                  # Contains __version__, __developer_id__
+│   ├── main.py                      # Entry point
+│   ├── app.py                       # Textual App class
+│   ├── views/                       # Screens: home, config, training, eval
+│   ├── components/                  # Reusable widgets
+│   ├── logic/                       # Non-UI logic: Docker, config, submit
+│   └── assets/                      # ASCII, icons, splash art
+├── logo.png                         # Project icon
+├── README.md
+├── requirements.txt
+├── pyproject.toml (optional)
+└── dist/                            # Built .exe from PyInstaller
+````
+
+---
+
+## 🧰 Requirements
+
+Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+> Includes: `textual`, `rich`, `diambra-arena`, `pyyaml`, `typer`
+
+---
+
+## ▶️ Running Agent M
+
+```bash
+python -m agentm
+```
+
+---
+
+## 📦 Build as Executable
+
+Using [PyInstaller](https://pyinstaller.org/):
+
+```bash
+pyinstaller --onefile agentm/main.py --name agentm --add-data "agentm/assets:splash"
+```
+
+The final `.exe` will be located in the `dist/` directory.
+
+---
+
+## 🧾 Developer Attribution
+
+All agents submitted through Agent M include a hardcoded developer ID:
+
+```python
+__developer_id__ = "mscrnt-0001"
+```
+
+This allows future reward attribution or referral tracking.
+
+---
+
+## 📣 License
+
+[MIT](LICENSE) — Created by [mscrnt](https://github.com/mscrnt)