a2nr
/
velxio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
velxio/docs/intro.md

70 lines
2.5 KiB
Markdown
Raw Normal View History

Create documentation page accessible at /docs - Add docs/ folder with intro, getting-started, emulator, components, roadmap markdown files - Add DocsPage.tsx with sidebar navigation, section content, pagination - Add DocsPage.css matching existing dark theme - Register /docs route in App.tsx - Add /docs to sitemap.xml Co-authored-by: davidmonterocrespo24 <47928504+davidmonterocrespo24@users.noreply.github.com>
2026-03-11 22:56:06 +07:00
# Velxio — Introduction
**Velxio** is a fully local, open-source Arduino emulator that runs entirely in your browser.
Write Arduino C++ code, compile it with a real `arduino-cli` backend, and simulate it using true AVR8 / RP2040 CPU emulation — with 48+ interactive electronic components, all without installing any software on your machine.
---
## Why Velxio?
- **No installation required** — everything runs in the browser.
- **Real emulation** — not a simplified model, but accurate AVR8 / RP2040 CPU emulation.
- **Interactive components** — LEDs, buttons, potentiometers, displays, sensors, and more.
- **Open-source** — inspect, modify, and self-host it yourself.
---
## Supported Boards
| Board | CPU | Emulator |
|-------|-----|----------|
| Arduino Uno | ATmega328p @ 16 MHz | avr8js |
| Arduino Nano | ATmega328p @ 16 MHz | avr8js |
| Arduino Mega | ATmega2560 @ 16 MHz | avr8js |
| Raspberry Pi Pico | RP2040 @ 133 MHz | rp2040js |
---
Refactor code structure for improved readability and maintainability
2026-03-17 00:22:23 +07:00
## Documentation
### Getting Started
- [Getting Started](./getting-started.md) — Quick setup guide (hosted, Docker, manual)
- [Introduction](./intro.md) — Overview, supported boards, quick links
### Architecture & Internals
- [Architecture](./ARCHITECTURE.md) — High-level project architecture
- [Emulator Architecture](./emulator.md) — How CPU emulation works layer by layer
- [Wokwi Libraries Integration](./WOKWI_LIBS.md) — Local wokwi-elements, avr8js, rp2040js setup
### Boards & Emulation
- [RP2040 Emulation](./RP2040_EMULATION.md) — Raspberry Pi Pico / Pico W in-browser emulator (ARM Cortex-M0+)
- [Raspberry Pi 3 Emulation](./RASPBERRYPI3_EMULATION.md) — BCM2837 / QEMU raspi3b, Python + GPIO shim
- [ESP32 Emulation](./ESP32_EMULATION.md) — Full Xtensa QEMU emulation (GPIO, ADC, PWM, WiFi, I2C, SPI, RMT)
- [RISC-V Emulation](./RISCV_EMULATION.md) — ESP32-C3 / XIAO-C3 in-browser emulator
### Components & Examples
- [Components Reference](./components.md) — All 48+ supported electronic components
- [Example Projects](./examples/README.md) — Built-in example gallery
### API & Integrations
- [MCP Server](./MCP.md) — Model Context Protocol server for AI agent integration
### Project Status
- [Roadmap](./roadmap.md) — Implemented, in-progress, and planned features
- [Setup Complete](./SETUP_COMPLETE.md) — Feature implementation status log
---
## Community & Links
Create documentation page accessible at /docs - Add docs/ folder with intro, getting-started, emulator, components, roadmap markdown files - Add DocsPage.tsx with sidebar navigation, section content, pagination - Add DocsPage.css matching existing dark theme - Register /docs route in App.tsx - Add /docs to sitemap.xml Co-authored-by: davidmonterocrespo24 <47928504+davidmonterocrespo24@users.noreply.github.com>
2026-03-11 22:56:06 +07:00
- [Live Demo](https://velxio.dev)
- [GitHub Repository](https://github.com/davidmonterocrespo24/velxio)
Refactor code structure for improved readability and maintainability
2026-03-17 00:22:23 +07:00
- [Discord](YOUR_DISCORD_INVITE_URL) — Ask questions, share projects, report issues