YASHIMA ENGINE

An educational rendering engine focused on accessibility and learning.

Getting Started • Documentation • Contributing • Educational Resources

---

🎯 Project Vision

Yashima Engine is an educational rendering engine designed to bridge the gap between graphics programming theory and practice. Our focus is on providing a clear, well-documented learning path for graphics programming enthusiasts.

Key Features

• 📚 Educational-first approach
• 🔍 Transparent rendering pipeline
• 📊 Built-in performance analysis tools
• 📖 Comprehensive documentation
• 🎓 Interactive learning tools

🚧 Project Status

This project is in initial development. Current phase: Architecture Design

Hardware Requirements

Minimum (Educational Focus)

• CPU: Intel i3 8th Gen / AMD Ryzen 3 2200G
• GPU: Intel UHD 620 or equivalent integrated graphics
• RAM: 8GB System Memory
• API: Vulkan 1.2

Recommended

• CPU: Intel i5 10th Gen / Ryzen 5 3600
• GPU: GTX 1650 / RX 580 / Intel Arc A380
• RAM: 16GB System Memory
• API: Vulkan 1.3

🚀 Getting Started

[Coming Soon]

📖 Documentation

Our documentation is structured to support both learning and development:

Core Documentation

• Vision and Scope
• Architecture Overview
• Development Setup

Educational Resources

• Graphics Pipeline Fundamentals
• Performance Optimization Guide
• Resource Management

API Documentation

• Core API Reference
• Rendering Pipeline API
• Resource Management API

🤝 Contributing

We welcome contributions from developers of all skill levels! See our Contributing Guide for details.

Development Prerequisites

• Visual Studio 2019+
• Vulkan SDK 1.2+
• CMake 3.20+
• Python 3.8+

Getting the Source

git clone https://github.com/ariargenta/yashima-engine.git
cd yashima-engine