Andromeda Documentation

Welcome to the Andromeda documentation! This directory contains comprehensive guides, API references for the Andromeda JavaScript/TypeScript runtime.

📚 Documentation Structure

🚀 Getting Started

• Installation Guide - How to install and set up Andromeda
• Quick Start - Your first Andromeda program
• CLI Reference - Complete command-line interface documentation

🛠️ API Documentation

• File System API - File I/O operations and path manipulation
• Canvas API - 2D graphics and image generation
• Crypto API - Cryptographic operations and security
• Console API - Enhanced console output and debugging
• Performance API - Timing and performance monitoring
• Process API - System interaction and environment access
• Time API - Date, time, and timing utilities
• Fetch API - HTTP client and Headers manipulation
• URL API - URL parsing, construction, and manipulation
• Web APIs - Standard web APIs (Events, TextEncoder/Decoder, etc.)
• SQLite API - Database operations with SQLite support

🔧 Development

• Contributing Guide - How to contribute to Andromeda
• Building from Source - Compiling Andromeda yourself
• Testing Guide - Running and writing tests

📋 Reference

• Examples Index - Code examples and practical demonstrations
• FAQ - Frequently asked questions
• Troubleshooting - Common issues and solutions

🎯 Standards Compliance

Andromeda aims to be WinterTC compliant, ensuring interoperability with the broader JavaScript ecosystem. Our APIs follow established web standards including:

• WHATWG Standards - URL, Encoding, and Fetch specifications
• W3C Standards - Canvas 2D, Performance API, Web Crypto API
• ECMAScript Standards - Modern JavaScript/TypeScript features

✨ Key Features

• 🚀 Zero-configuration TypeScript - Run .ts files directly
• 🎨 Canvas & Graphics - Full 2D Canvas API with PNG export
• 🔐 Web Crypto API - Industry-standard cryptographic primitives
• 📁 File System Access - Comprehensive file I/O operations
• 🗃️ SQLite Database - Built-in database support with sync API
• ⚡ Native Performance - Rust-powered execution with Nova engine
• 🛠️ Developer Tools - REPL, formatter, compiler, and auto-upgrade
• 🌐 Web Standards - TextEncoder/Decoder, Performance API, and more

🆘 Getting Help

• 💬 Discord Community - Chat with the community
• 🐛 GitHub Issues - Report bugs or request features
• 📧 Discussions - Ask questions and share ideas

📄 License

This documentation is licensed under the Mozilla Public License Version 2.0.