Getting Started

This guide will help you get started with LayKit, from installation to your first working program.

Prerequisites

Before using LayKit, ensure you have:

  • Rust 1.70 or later - Install Rust
  • Cargo - Comes with Rust installation
  • Basic familiarity with Rust programming

System Requirements

LayKit works on all major platforms:

  • Linux - Fully supported and tested
  • macOS - Fully supported (both Intel and ARM)
  • Windows - Fully supported (including WSL2)

Memory Requirements:

  • Minimum: 100MB RAM
  • Recommended: System RAM > 2× your largest layout file size
  • Files are loaded entirely into memory

Next Steps

Continue to:

Getting Help

If you encounter any issues:

  1. Check the examples for similar use cases
  2. Review the API Reference for detailed documentation
  3. Search GitHub Issues for known problems
  4. Open a new issue if you find a bug or have a feature request