Weaver — Documentation

Welcome to the official documentation of Weaver.

This documentation provides information for both end users and developers:

• End users will learn how to install, configure, and use the program.

• Developers will find detailed information about the internal architecture, build system, and contribution process.

---

---

Getting Started

If you are new to the project, start here:

• Installation

• Usage

• Examples

For developers, visit the Build System section.

---

Documentation Structure

📘 User Guide

• Installation
  • Windows
  • Linux
• Configuration
  • Types of Configurations
  • Folder Structure
  • File Descriptions
  • Configuration Parameters
• Usage
  • Command-line Options
  • Modes of Execution
  • Output Folder
  • Interactive Input (Non-GUI)
  • Graphical Interface (GUI)
  • Summary
• Examples
• Troubleshooting

🧠 Developer Guide

• Build System
  • Common Requirements
  • Release Requirements
  • Documentation Requirements
  • Developer Setup
  • CMake Presets
  • Updating vcpkg Version
• Adding Features
  • Branch Strategy
• Contribution
  • Pull Requests
  • Code Review
  • Issues
• Code Style
  • General Guidelines
  • Formatting
  • Comments
• JSON validator
  • Getting Started
  • Advanced Features

⚙️ Reference

• API

🧪 Testing and Deployment

• Overview
• Unit Tests
• Continuous Integration & Continuous Deployment (CI/CD)
  • Configuration
  • Workflows

---

Additional Resources

• 🏠 Project Repository

• 🧩 API Reference

• 💬 Report Issues