From f7766fb8eb032bf9e913f6d08064ccd869d26948 Mon Sep 17 00:00:00 2001
From: Niklas Peng <niklas.peng@stud.fhgr.ch>
Date: Fri, 30 May 2025 19:45:40 +0200
Subject: [PATCH] README.md

---
 README.md | 131 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 131 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5390ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,131 @@
+# AI-Supported Code Editor
+
+A lightweight code editor with AI assistance, built using Streamlit.
+
+## Features
+
+- **File Navigation**: Browse and edit code files in a project directory with an enhanced tree view (nested)
+- **AI Assistant**: Chat with an AI assistant (OpenAI or Anthropic) for code suggestions, debugging, and explanations
+- **Code Execution**: Run Python code directly in the editor and capture outputs
+- **Syntax Highlighting**: View code with syntax highlighting for better readability
+- **Web Search**: Search the internet for documentation and examples
+- **AI Commands**: Use special commands like `/improve` and `/explain` to get targeted AI assistance
+- **Modern UI**: Clean, VS Code-inspired interface with customizable layout
+
+## Project Structure
+
+```
+codeeditor/
+├── src/
+│   ├── codeeditor/        # Core package code
+│   ├── streamlit_app.py   # Streamlit application entry point
+│   └── main.py           # Main application module
+├── tests/                # Test suite
+├── docs/                # Documentation
+├── requirements.txt     # Project dependencies
+├── pyproject.toml      # Project metadata and build configuration
+└── .pre-commit-config.yaml  # Pre-commit hooks configuration
+```
+
+## Installation
+
+```bash
+# Clone the repository from Gitea
+git clone https://https://gitea.fhgr.ch/pengniklas/codeeditor.git
+cd codeeditor
+
+# Create and activate virtual environment (Windows)
+python -m venv venv
+.\venv\Scripts\activate
+
+# On macOS/Linux
+# python -m venv venv
+# source venv/bin/activate
+
+# Install the package in development mode
+pip install -e .
+
+# Install additional dependencies
+pip install -r requirements.txt
+```
+
+## Configuration
+
+1. Copy the example environment file:
+```bash
+cp src/codeeditor/env_example .env
+```
+
+2. Edit the `.env` file with your API keys:
+```
+# AI Provider Configuration
+# Set to "anthropic"
+AI_PROVIDER=anthropic
+
+# Anthropic API Configuration (if using Anthropic)
+ANTHROPIC_API_KEY=your_anthropic_api_key_here
+ANTHROPIC_MODEL=claude-3-opus-20240229
+
+# Search API Configuration (Google Custom Search)
+SEARCH_API_KEY=your_google_api_key_here
+SEARCH_ENGINE_ID=your_search_engine_id_here
+```
+
+## Usage
+
+```bash
+# Run the application using Streamlit
+streamlit run src/streamlit_app.py
+
+# Or directly using the module
+python -m src.main
+```
+
+## How to Use
+
+1. **Navigate Files**: Use the file explorer in the left sidebar to browse your project files
+2. **Edit Code**: Select a file to open it in the editor, make changes, and save
+3. **Execute Code**: For Python files, click "Run Code" to execute and see the output
+4. **AI Assistance**: Use the chat interface in the right sidebar to ask the AI for help with your code
+5. **Web Search**: Search for documentation or examples directly from the editor
+6. **AI Commands**: Use special commands in the chat:
+   - `/improve` - Get suggestions to improve the current file's code
+   - `/explain` - Get a detailed explanation of how the current file's code works
+   - `/help` - Show available commands
+   - `/clear` - Clear the chat history
+
+## Layout
+
+The application has a three-column layout:
+
+- **Left Sidebar**: File explorer with file operations (new, save, delete)
+- **Main Area**: Code editor with syntax highlighting
+- **Right Sidebar**: AI Assistant with chat interface and quick action buttons
+
+## Choosing an AI Provider
+
+The application supports one AI providers:
+
+1. **Anthropic**: Uses Claude models for AI assistance
+   - Set `AI_PROVIDER=anthropic` in your .env file
+   - Provide your Anthropic API key in the `ANTHROPIC_API_KEY` field
+
+## Development
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Set up pre-commit hooks
+pre-commit install
+
+# Run tests
+pytest
+
+# Run linting
+flake8
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.