fix license add readme

LICENSE

@@ -1,21 +1,14 @@
-MIT License
+# DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 
-Copyright (c) 2024 Balazs Horvath
+Version 2, December 2024
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Copyright (C) 2024 Balazs Horvath
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+1. You just DO WHAT THE FUCK YOU WANT TO.

README.md

@@ -1,3 +1,203 @@
 ---
 license: wtfpl
 ---
+
+<!-- markdownlint-disable MD029 -->
+
+# AI Image Processing Toolkit
+
+---
+
+A collection of specialized scripts for AI image processing, dataset preparation, and model training workflows.
+
+## 🛠️ Scripts Overview
+
+---
+
+### WDV3 (Waifu Diffusion V3 Tagger)
+
+An image tagging script using the WD V3 tagger models. Supports multiple model architectures (ViT, SwinV2, ConvNext) and can process both single images and directories recursively.
+
+#### Features
+
+- Multiple model architecture support
+- Batch processing capabilities
+- Adjustable confidence thresholds
+- CUDA acceleration with FP16 support
+- JXL image format support
+
+### Training Functions (train_functions.zsh)
+
+A set of ZSH functions for managing AI model training workflows:
+
+- Script execution management
+- Training variable setup
+- Git repository state tracking
+- Output directory management
+- Automatic cleanup of empty outputs
+
+### Git Wrapper (git-wrapper.zsh)
+
+Enhanced Git functionality for dataset management:
+
+- Automatic submodule handling
+- LFS integration for JXL files
+- Dataset-specific Git attributes management
+
+### Check4sig (check4sig.zsh)
+
+Dataset caption file watermark detection utility:
+
+- Scans .caption files for watermark-related text
+- Batch processing support
+- Interactive editing with nvim
+- Recursive directory scanning
+
+### Gallery-dl Wrapper (gallery-dl.zsh)
+
+Directory-aware wrapper for gallery-dl:
+
+- Automatically changes to ~/datasets directory
+- Maintains consistent download locations
+- Preserves original command functionality
+
+### JoyCaption (joy)
+
+Advanced image captioning system using CLIP and LLM:
+
+- Multiple caption styles (descriptive, training prompts, art critic, etc.)
+- Custom image adapters
+- Tag-based caption generation
+- Batch processing support
+
+### PNG to MP4 Converter (png2mp4)
+
+Training progress visualization tool:
+
+- Converts PNG sequences to MP4
+- Customizable frame rates and durations
+- Step counter overlay support
+- Multiple sample handling
+
+### XY Plot Generator (xyplot)
+
+Image comparison grid generator:
+
+- Supports multiple image formats
+- Customizable grid layouts
+- Optional row/column labels
+- Automatic image padding and alignment
+
+### Caption Concatenator (concat_captions)
+
+Utility for combining multiple caption files:
+
+- Merges .caption and .tags files
+- Maintains original image associations
+- Batch processing support
+- Error handling for missing files
+
+<!-- ⚠️ TODO: add more scripts -->
+
+## 🚀 Installation
+
+---
+
+1. Clone the repository: (optional)
+
+```bash
+git clone https://huggingface.co/k4d3/toolkit
+```
+
+2. Add the repository to your PATH: (optional)
+
+```bash
+export PATH="$PATH:~/path/to/toolkit"
+```
+
+3. Add the `.zshrc` to your shell: (optional and you will need to make changes to it)
+
+```bash
+source ~/path/to/toolkit/.zshrc
+nano ~/.zshrc
+```
+
+## 📝 Requirements
+
+---
+
+- miniconda with the environment set up for training with sd-scripts, timm, etc
+- ZSH shell (optional)
+- CUDA-capable GPU (recommended)
+- Required Python packages:
+  - torch
+  - transformers
+  - pillow
+  - pillow-jxl
+  - opencv-python
+  - numpy
+  - and a lot more
+
+## 🔧 Usage
+
+---
+
+Each script can be used independently or as part of a workflow. Here are some common usage examples:
+
+<!-- ⚠️ TODO: add more usage examples -->
+
+### JoyCaption
+
+```bash
+joy --feed-from-tags=10 --custom_prompt="Write a very long descriptive caption for this image in a formal tone. Do not mention feelings and emotions evoked by the image." .
+```
+
+### png2mp4
+
+```bash
+png2mp4 --repeat 16
+```
+
+### inject_to_txt
+
+```bash
+inject_to_txt 1_honovy "honovy"
+```
+
+### replace_comma_with_keep_tags_txt
+
+```bash
+replace_comma_with_keep_tags_txt 1 1_honovy
+```
+
+## 📦 Directory Structure
+
+---
+
+```bash
+~/
+├── datasets/
+├── output_dir/
+├── models/
+├── toolkit/
+```
+
+## 📄 License
+
+---
+
+[WTFPL](http://www.wtfpl.net/) - Do what the fuck you want with it.
+
+The included data and models are copyrighted by their respective owners with their own licenses.
+
+## 🤝 Contributing
+
+---
+
+Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+## 📚 Documentation
+
+---
+
+If the documentation of a script is missing, ask a language model about it.