Commit Graph

1 Commits (992f3e7d55949586f1482da8988e1af293d68774)

Author SHA1 Message Date
bmaltais f28f96b111
Docs: Comprehensive README overhaul (#3245)
This commit significantly revamps the README.md to improve clarity,
organization, and completeness for you.

Key changes include:
- Enhanced project introduction: Clearly defines project purpose and key features.
- Improved structure:
    - Moved detailed installation guides (Docker, Runpod, Novita) and specific
      troubleshooting (Tesla V100) to separate files in `docs/`.
    - Standardized formatting for notes, warnings, and important messages.
- Content updates and additions:
    - Added a "Prerequisites" section.
    - Expanded the "LoRA" section with links to detailed documentation.
    - Updated "SDXL training" and "Masked loss" sections, removing obsolete notes.
    - Added "Contributing" guidelines and a "License" section.
    - Incorporated badges for GitHub stars, forks, license, and issues.
    - Removed the outdated "ToDo" section.
- Link verification: Ensured internal links are correct and external links
  are properly formatted.
- Change History: Condensed the verbose v25.0.0 entry for better readability.

These changes aim to provide a more user-friendly and informative entry
point for the Kohya's GUI project.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
2025-05-23 20:27:23 -04:00