Update README.md

Author: SimonHeggie

README.md

@@ -1,114 +1,128 @@
-# GatherResources, the blender way of collecting video files.
+# Gather Resources — the Blender way to collect your project’s media
 
-Collect/Assemble/Gather all resources to the texture child directory. AKA: 'GET YOUR SHIT TOGETHER.'
+Collect / assemble / gather all external resources into a single folder with one click.  
+Or, in plain English: **GET YOUR SHIT TOGETHER.**
 
-<img src="GatherResources.png">
+<img src="GatherResources.png" width="420">
 
-Early testing has begun.
+Early testing shows it handles most production scenarios correctly —  
+but as always: **Make back-ups if testing with major productions.**
 
-I have tested a couple of scenarios, but TEST AT YOUR OWN PERIL.... Be sure to test it on something that you don't mind destroying. 
+---
 
+## What This Add-on Does
 
-## Installation:
+**Gather Resources** scans your Blender project for:
 
-Download from here: https://github.com/SimonHeggie/Blender-GatherResources/archive/refs/heads/main.zip (DO NOT UNZIP)
+- VSE video strips  
+- Audio strips  
+- Image textures  
+- Images used in materials  
+- Cache files (e.g., mesh sequence caches)  
+- Other external media referenced by your `.blend`
 
-In blender: Edit/Preferences/Add-ons... Top right arrow, 'Install from Disk'. Select the Gather Resources zip file, then tick it to activate.
+Then it copies all discovered files into a local `textures/` directory beside your `.blend` file.
 
-## Usage:
+It’s basically **After Effects Collect Files**, but for Blender.
 
-File > External Data > Gather Resources: 
+---
 
-This will take all resources used within your project and relocate them to your child texture directory.
+## How to Use
 
-## (Speculative) Road Map:
+Once installed and enabled:
 
-### Alpha:
+**File → External Data → Gather Resources**
 
-- If a duplicate is found somehow; either rename the file, or place in number clone folder. Should be dedectable via comparing file sizes.
-- There is currently a bug where sub-folders in the texture folder are moved into the root of textures which may result in unwanted merged data.
-- If a duplicate is found and it has the exact same file size, technically that should be re-used instead of causing uneccesary clone data bloat. (This means that asset versioning is up to the users to manage)
+Blender will create a `textures/` directory beside your `.blend`,  
+and copy all referenced external files into it.
 
-### Beta
-
-- Full cross platform support (Linux, Windows, Mac)
+A summary of collected files will appear in the status bar.
 
-### Production ready Stable build:
+---
 
-- All bugs founds and crushed
+## Roadmap (Speculative)
 
-### Future ideas:
+### Alpha (Current Phase)
+- Avoid duplicate file creation by checking size+mtime before copy  
+- Smarter detection of duplicate files already present  
 
-- Menu option to 'Automatically Gather Resources'
-- Either combine the task of, or create a seperate option for capturing all PROXY and CACHE data, which should be gathered but probably not into the 'textures' directory, seeing as it's something that it not as essential as the core resources needed to re-bake and re-render.
-- 'Distribute Resources' Sort of like unpack; does the opposite of Gather. It requires storing the original locations of files prior to being gathered. Usecase is updating modified library and stock content for example.
-- Support for resource data which is linked and needs to be gathered and vise-versa
-- (Very unsure of where this is essential or not...) Collapse the entire 'PACK' menu into one sub-menu and do the same for the gathering commands to neaten the entire menu.
-- CLEAN resources: FIRST; warns the users to double check that any other blend files are not share data, and if they are to append all into one blend file before hand. (can remove warning) THEN finds every file NOT being read by the active blend file and removes it. This is going to be SO helpful for optimizing for easy deployment and archiving.
+### Beta
+- Confirm full cross-platform behaviour (Linux, Windows, macOS)  
+- Stabilise overwrite and conflict-resolution logic  
 
-### Final plan:
+### Production / Stable
+- Full bug elimination  
+- Hardened reliability for archiving, backup, and project transfer  
 
-- Polish the Addon: Ensure code quality, follow Blender's coding guidelines, and fully document the addon.
-- Submit to Blender Developers: Create a task on Blender Developer Site and submit the addon for review.
-- Engage with Developer Community: Discuss the proposal on the Blender Developer forums or IRC to gather feedback.
-- Address Feedback: Make necessary improvements based on code reviews and feedback from Blender's core development team.
-- Wait for Testing and Integration: The addon will go through further testing, and if accepted, it will be included in a future Blender release.
+### Future Ideas
+- **Auto-Gather Mode** (toggle to run after saving or before rendering)
+- **Gather Proxy / Cache Data** into a separate folder  
+- **Distribute Resources**  
+  - Opposite of Gather — restore files to original locations using stored mappings  
+- **Cleanup Mode**  
+  - Identify unused files  
+  - Warn if other `.blend` files share dependencies  
+  - Remove unreferenced assets for archiving  
+- **Menu streamlining** (collapse Pack + Gather tools under one section)
 
-## Reporting BUGS:
+---
 
-This is going to be full of bugs, so any testing is apreciated.
+## Reporting Bugs
 
-#### Report bugs to:
+This add-on is new and will absolutely have bugs.  
+Any testing you can provide is appreciated.
 
+Submit issues here:  
 https://github.com/SimonHeggie/Blender-GatherResources/issues
 
-And please use the following, or similar bug reporting template (Copy and paste it :)):
+Please use the template below:
+
+---
 
--
+### 🐛 Bug Report Template
 
 #### 1. Summary of the Issue
+What went wrong?  
+What did you expect to happen?
 
-What’s not working? (E.g., "File links are not updating to the new 'textures' folder.")
-What did you expect to happen? (E.g., "The script should copy files to the 'textures' folder and update the paths to relative links.")
+#### 2. Steps to Reproduce
+1. Open Blender (include version).  
+2. Set up scene with videos/images/audio/cache/etc.  
+3. Run Gather Resources.  
+4. Check the `textures/` directory.
 
-#### 2. Steps to Reproduce the Issue
+#### 3. Expected vs. Actual Behaviour
+Expected:  
+Actual:
 
-Provide a step-by-step guide to reproduce the problem:
+#### 4. System Information
+- OS:  
+- CPU:  
+- GPU:  
+- RAM:  
+- Blender Version:  
 
-Open Blender [Version Number].
-Set up a scene with videos, images, sounds, or Alembic caches.
-Run the Gather Resources script.
-Check if all files were copied to the textures/ folder and paths were correctly updated.
+#### 5. Files and Formats Involved
+Which types were present and which failed?
 
-#### 3. Expected vs. Actual Behavior
-Expected Behavior: (E.g., "Files should be copied to the 'textures' folder, and their paths updated to relative links.")
-Actual Behavior: (E.g., "Files remained in their original location, or the paths were not updated.")
+- Video (.mp4, .mkv, etc.)  
+- Image (.png, .jpg, etc.)  
+- Audio (.wav, .mp3, etc.)  
+- Alembic (.abc)  
+- Models (.fbx, .obj, etc.)
 
-#### 4. System Information
+#### 6. Errors or Console Output
+Paste any error messages or logs.
+
+#### 7. Attempts to Fix / Workarounds (If Any)
+What have you already tried?
+
+#### 8. Additional Context
+Does it happen always, or intermittently?  
+Project-specific or global?
 
+---
 
-Operating System: (E.g., Windows 11, Ubuntu 22.04, macOS 13)
-CPU: (E.g., Intel Core i9-13900HX)
-GPU: (E.g., NVIDIA RTX 4070)
-RAM: (E.g., 32GB)
-Blender Version: (E.g., 4.0.1, 3.6.5)
-5. Files and Formats Involved
-Were all file types handled correctly?
-(E.g., "The script copied image files, but skipped .abc files.")
-Relevant Formats in Use: (Check all that apply)
- Video (.mp4, .mkv, etc.)
- Image (.png, .jpg, etc
-.)
- Audio (.wav, .mp3, etc.)
- Alembic (.abc)
- 3D Models (.fbx, .obj, etc.)
-
-#### 6. Error Messages or Console Output
-Were there any errors? (If yes, provide the exact error message or attach a screenshot of the console output.)
-
-#### 7. Workarounds or Attempts to Fix (If Any)
-What have you tried so far? (E.g., “Tried running the script on a fresh project, but the issue persists.”)
-
-#### 8. Additional Context or Observations
-How often does the issue occur? (E.g., Every time, or intermittently?)
-Is this project-specific? (Does the problem happen in only one project or across multiple?)
+## License
+GPL-3.0-or-later  
+© 2024–2025 Simon Heggie