iris-thaumantias README

Iris Thaumantias is an AI-driven tutoring extension for computer science students. It integrates with course material to provide context-aware, personalized support during programming exercises.

Features

Artemis Integration

• Activity Bar Icon: Click the Artemis logo in the activity bar to open the login sidebar
• Secure Login: Login to your Artemis Learning Management System directly from VS Code
• Responsive Design: The login interface adapts to VS Code themes (light/dark mode)

AI Tutoring (Coming Soon)

• Context-aware programming assistance
• Personalized hints and guidance
• Integration with course materials

How to Use

1. Click the Artemis logo in the activity bar
2. Enter your username and password
3. Click "Login to Artemis" to authenticate
4. To change settings, click the settings gear icon (⚙️) in the bottom left corner

Extension Settings

This extension contributes the following settings:

• artemis.serverUrl: The URL of the Artemis server to connect to (default: https://artemis.tum.de)

Requirements

• VS Code version 1.104.0 or higher
• Access to an Artemis Learning Management System server
• Valid Artemis user credentials

Commands

This extension contributes the following commands:

• Artemis: Login to Artemis - Opens the Artemis login interface
• Artemis: Check Iris Health Status - Checks if the Iris AI tutoring system is active and shows rate limit information

To run a command, open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and type the command name.

Extension Settings

This extension contributes the following settings:

• artemis.serverUrl: The URL of the Artemis server to connect to (default: https://artemis.tum.de)
• artemis.theme: Choose the visual theme for Artemis views (vscode, modern, or synthwave)

Known Issues

• Iris AI tutoring features are still under development
• Some features may require specific Artemis server configurations

Release Notes

0.0.1

Initial development release:

• Artemis authentication system
• Basic UI framework with theme support
• Iris health status checking command

1.1.0

Added features X, Y, and Z.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!