Add project documentation: AGENTS.md and README.md
This commit is contained in:
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# eFiling Automation
|
||||
|
||||
Automating the process of e-filing legal documents.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
├── AGENTS.md # AI agent instructions & project context
|
||||
├── README.md # This file
|
||||
├── videos/ # Research videos: manual workflows + competitor demos
|
||||
├── docs/ # Documentation
|
||||
│ └── research/ # Research notes & analysis (driven by video-based skills)
|
||||
└── app/ # Python codebase (managed with uv)
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
This project aims to automate the e-filing workflow. We take a methodical approach:
|
||||
|
||||
1. **Research** — Watch and analyze videos showing both the manual filing process and competitor solutions. Skills are built to extract and organize insights from these videos. Research findings are documented in `docs/research/`.
|
||||
2. **Build** — Implement the automation as a Python application in `app/`, using [uv](https://github.com/astral-sh/uv) for dependency and virtual environment management.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Language**: Python
|
||||
- **Dependency Manager**: uv (`pyproject.toml` + `uv.lock`)
|
||||
- **Video Analysis**: Custom skills for research pipeline
|
||||
|
||||
## Quick Start (after research phase)
|
||||
|
||||
```bash
|
||||
cd app
|
||||
uv sync # Install dependencies
|
||||
uv run python -m app # Run the application
|
||||
```
|
||||
Reference in New Issue
Block a user