Getting Started

This section contains quick start setup and installation instructions to get FABulous running locally.

• Quick start
  • 1. Install FABulous
  • 2. Install CAD tools
  • 3. Create a project
  • 4. Generate fabric and bitstream
  • 5. Check the outputs
  • What’s next?
• Using FABulous in GitHub Codespaces
  • Quick Start
  • Accessing GUI Applications
    • Opening the GUI
  • Running FABulous
    • Creating a Project
    • Using GUI Tools
  • Tips and Troubleshooting
    • Performance
    • Persistence
    • Running Out of Space
    • GUI Not Appearing
  • Advantages of Codespaces
  • Differences from Local Setup
  • Next Steps
• Installation Method
  • uv based setup
    • Installing uv
    • Install FABulous
  • venv based setup
    • Dependencies
    • FABulous repository
    • Virtual environment
    • Install FABulous
  • Install Required CAD tools
    • Installing Non required CAD tools
  • docker based setup
    • Pre-built Docker Images
      • Release Image (Recommended for Users)
      • Development Image (For Contributors)
    • Running the Docker Container
      • Basic Usage
      • Development Usage
      • With GUI Support (Linux)
    • Using Dev Containers (Local Development)
      • Prerequisites
      • Getting Started
    • Troubleshooting
      • GUI applications crash with “could not connect to display”
      • Permission denied errors
      • OpenGL/GLX warnings
  • Nix-based Development Environment
    • Setting Up the Nix Environment
    • Already have Nix setup
    • Activating the Nix Shell