# fredegd/easyease architecture

> Architecture diagram of the GitHub repository fredegd/easyease, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fredegd/easyease
- Repository: https://github.com/fredegd/easyease

## Overview

##### Project type and purpose
- This is an open-source Processing library (Java) named **EasyEase** that provides easing functions and non-linear distribution utilities.
- Its goal is to let Processing sketches easily apply easing curves to spatial distributions or animations.

##### File structure
- **src/easy/ease/** contains the Java source code (core library).
- **examples/** and **docs/examples/** hold sample Processing sketches (.pde) illustrating usage.
- **mkdocsGenerator/** contains Markdown source and assets for the documentation site.
- **docs/** is the generated static site (HTML, JS, CSS, images) for GitHub Pages.
- Configuration files: **mkdocs.yml** drives the docs build; **.gitignore** and **license.txt** exist at top level.

##### README for additional insights
- The README confirms no external dependencies; it describes installation, usage, and points to the online docs and examples.
- It outlines the core classes (e.g., `EasyEase`, `EasingMethods`) and shows a minimal code snippet.

##### Diagramming conventions
- Source → Build → JAR → Releases
- JAR → Processing IDE → Example Sketches
- Markdown → MkDocs → HTML → GitHub Pages
- Library & code (blue)
- Documentation flow (green)
- Examples/sketches (orange)
- External services (gray)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Core Library Module"
        direction TB
        A1["EasyEase.java"]:::library
        A2["EasingMethods.java"]:::library
        Build["Build JAR"]:::library
        A1 --> Build
        A2 --> Build
        Build --> JAR["EasyEase.jar"]:::library
    end

    subgraph "GitHub (Source & Releases)"
        direction TB
        Repo["GitHub Repo"]:::external
        README["README.md"]:::external
        License["license.txt"]:::external
        Releases["GitHub Releases"]:::external
        Pages["GitHub Pages"]:::external
        Repo --> README
        Repo --> License
        Repo -->|push code| Releases
        JAR -->|publish| Releases
        Repo -->|host site| Pages
    end

    subgraph "Processing IDE"
        direction TB
        IDE["Processing IDE"]:::external
        Releases -->|install JAR| IDE
    end

    subgraph "Example Sketches"
        direction TB
        ExamplesDir["examples/"]:::example
        ExamplesDir -->|run sketches| IDE
    end

    subgraph "Docs Generator"
        direction TB
        MkSrc["mkdocsGenerator/"]:::docs
        MkCfg["mkdocs.yml"]:::docs
        MkBuild["MkDocs Build"]:::docs
        MkSrc --> MkBuild
        MkCfg --> MkBuild
        MkBuild --> Site["docs/"]:::docs
    end

    Site -->|deploy| Pages

    click A1 "https://github.com/fredegd/easyease/blob/main/src/easy/ease/EasyEase.java"
    click A2 "https://github.com/fredegd/easyease/blob/main/src/easy/ease/EasingMethods.java"
    click ExamplesDir "https://github.com/fredegd/easyease/tree/main/examples/"
    click MkSrc "https://github.com/fredegd/easyease/tree/main/mkdocsGenerator/"
    click Site "https://github.com/fredegd/easyease/tree/main/docs/"
    click MkCfg "https://github.com/fredegd/easyease/blob/main/mkdocs.yml"
    click README "https://github.com/fredegd/easyease/blob/main/README.md"
    click License "https://github.com/fredegd/easyease/blob/main/license.txt"

    classDef library fill:#D6EAF8,stroke:#2980B9,color:#1B4F72;
    classDef docs fill:#D5F5E3,stroke:#27AE60,color:#1E8449;
    classDef example fill:#FCF3CF,stroke:#F1C40F,color:#B7950B;
    classDef external fill:#E5E7E9,stroke:#7F8C8D,color:#2C3E50;
```
