Rustelo/templates/shared/readme/rustelo-assets.md

{{ project.title or project.name }} - Assets Directory

This directory contains downloaded framework assets and templates for the {{ project.name }} implementation.

{% if project.description -%}

{{ project.description }} {% endif %}

Directory Structure

.rustelo-assets/
├── cache/           # Cached remote assets
├── templates/       # Downloaded template files
├── components/      # Reusable components from framework
├── styles/          # CSS and styling assets
└── README.md        # This file

Configuration

• Source: {{ assets.source }}
• Auto-update: {{ assets.auto_update }}
• Cache enabled: {{ assets.cache_enabled }}
• Download location: {{ assets.download_location }} {% if assets.framework_path -%}
• Framework path: {{ assets.framework_path }} {% endif %}

Project Information

• Template: {{ project.template }}
• Version: {{ project.version }}
• Created: {{ project.created }} {% if project.author -%}
• Author: {{ project.author }} {% endif %}

Features Enabled

{% if features -%} {% for feature, enabled in features -%} {% if enabled -%}

• ✅ {{ feature }}: Enabled {% endif -%} {% endfor -%} {% else -%}
• No features configured {% endif %}

Development Settings

• Hot reload: {{ development.hot_reload }}
• Port: {{ development.port }}
• Log level: {{ development.log_level }}
• Debug mode: {{ development.debug_mode }}

Usage

This directory is managed automatically by the Rustelo CLI:

# Sync assets from framework
cargo rustelo assets sync

# Check for asset conflicts
cargo rustelo assets check

# List available assets
cargo rustelo assets list

# Update assets
cargo rustelo update

Build Configuration

• Optimize: {{ build.optimize }}
• Compress assets: {{ build.compress_assets }}
• Generate sourcemaps: {{ build.generate_sourcemaps }}

Notes

• Do not manually edit files in this directory unless you know what you're doing
• Files may be overwritten during updates
• Use local-tasks.just for custom build steps that depend on these assets {% if custom -%}

Custom Configuration

{{ custom | json_encode(pretty=true) }} {% endif %}

---

Generated by Rustelo init