diff --git a/example-custom-content/README.md b/example-custom-content/README.md index 6a076a7c..c457da7e 100644 --- a/example-custom-content/README.md +++ b/example-custom-content/README.md @@ -2,3 +2,7 @@ This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file, These items will be discovered by the installer and offered for installation. + +This is how you could also create and share other custom agents and workflows not tied to a specific module. + +To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder. diff --git a/example-custom-content/custom.yaml b/example-custom-content/custom.bak similarity index 100% rename from example-custom-content/custom.yaml rename to example-custom-content/custom.bak diff --git a/example-custom-module/mwm/README.md b/example-custom-module/mwm/README.md index 290c1875..09e8aba8 100644 --- a/example-custom-module/mwm/README.md +++ b/example-custom-module/mwm/README.md @@ -2,3 +2,11 @@ This module is an example and is not at all recommended for any usage, this module was not vetted by any medical professionals and should be considered at best for entertainment purposes only. + +IF you want to see how a custom module installation works, copy this whole folder to where you will be installing from with npx, and rename +"\_module-installer/install-config.bak" to "\_module-installer/install-config.yaml". + +You should see the option in the module selector when installing. + +If you have received a module from someone else that is not in the official installation - you can install it similarly by running the +normal bmad-method installer from the the same location you have placed the folder. diff --git a/example-custom-module/mwm/_module-installer/install-config.yaml b/example-custom-module/mwm/_module-installer/install-config.bak similarity index 100% rename from example-custom-module/mwm/_module-installer/install-config.yaml rename to example-custom-module/mwm/_module-installer/install-config.bak