Simplified README in favor of Wiki

This commit is contained in:
doc-code 2024-09-04 13:48:46 +02:00
parent 52650546b5
commit c4878e1209

View File

@ -4,9 +4,9 @@
--- ---
- [Getting Started](#getting-started) - [Getting Started](https://projects.blender.org/Francesco-Bellini/custom_templates_addon/wiki/Getting-Started)
- [Why *Custom Templates*?](#why-custom-templates) - [Why this add-on?](https://projects.blender.org/Francesco-Bellini/custom_templates_addon/wiki/Why+this+add-on%3F.-)
- [Support](#support) - [Support](https://projects.blender.org/Francesco-Bellini/custom_templates_addon/wiki/Support)
- [Changelog](./CHANGELOG.md) - [Changelog](./CHANGELOG.md)
- [Copyright](#copyright) - [Copyright](#copyright)
@ -16,83 +16,6 @@
Your templates will be avaliable in the Splash Screen and the `File > New` menu. Your templates will be avaliable in the Splash Screen and the `File > New` menu.
## Getting Started
- **Prepare your templates** and save them **in `.blend` files**
*or find online `.blend` templates that fits your needs*
- **Define your templates** in the add-on's preferences
*It's simple. Select a `.blend` file and name your template.*
You can do this:
1) Directly from add-on preferences, in the templates list
2) By using `File > Defaults > Add from folder`
*Select a folder (and optionally a recursion depth, default 1) and find `.blend` files to use as template. By default, the clean file name will be used as name for the new templates.*
3) By using `File > Defaults > Select new template`
*Popup to specify name and path for the new template.*
4) By using `File > Defaults > Use current file as template` *(only avaliable when a saved .blend file is currently loaded)*
*Popup to specify the name for the new template. The path will be the one of the current .blend file.*
5) By importing a previously exported templates list from JSON file
*(Either using `File > Defaults > Import Templates` as well as from the menu located in the top right of the templates list in the preferences)*
*Note: the import process override the current list. Be sure to export the current list, if necessary.*
> *You can add, remove, reorder and update your templates any time...*
- *(Optionally)* **Export** your templates list to **JSON file**
*From `File > Defaults > Export templates`, or from the add-on preferences menu.*
*Useful after disabling and re-enabling the add-on, re-installing blender, or simply to prepare different sets of templates to import when needed.*
At this point your templates will be avaliable in the `File > New` menu and in the Splash Screen.
> You can update the contents of your `.blend` templates at any time. The file is read each time you open the template.
#### Splash Screen
From the Splash Screen (or from preferences), you can easily switch between your Custom Templates and Blender's default templates.
> *This only applies to the splash screen.
> `File > New` menu will always show all your templates.*
Notes:
- With more than 5 templates, only the first 5 will be shown in the splash. If this is your case, be sure to reorder on top the 5 you want to see in the splash.
- If you have no templates currently defined, Blender's default list will always be used (to avoid empty list in splash)
### Why *Custom Templates*?
Blender allows you to save you own .blend file to use on startup.
This is great, but wouldn't it be nice to be able to create your own templates?
With **Custom Templates** you can setup as many .blend file as you like, as templates.
---
Create your own templates or find the ones that best suit your needs online.
*Customize workspaces, preset your usual materials, define additional windows or anything else you would like to have from the beginning.*
*The only limit is your immagination!*
### Support
The versions avaliable at extensions.blender.org and directly from Blender's preferences, supports Blender 4.2 and later versions.
---
#### Legacy
For previous Blender versions, you can install the [legacy version](https://projects.blender.org/Francesco-Bellini/custom_templates_addon/releases/tag/v1.4.0).
It's tested on the following LTS previous versions:
- Blender `3.6 LTS`
- Blender `3.3 LTS`
- Blender `2.93 LTS`
- Blender `2.83 LTS`
- *And may of may not work on other not-LTS previous versions*
Download [Custom Templates Legacy](https://projects.blender.org/Francesco-Bellini/custom_templates_addon/releases/tag/v1.4.0).
> **Note**
> Only setup templates compatible with your current version of blender, otherwise you might get a warning or a crash (especially on Blender 2.x versions) while opening your templates.
### Changelog ### Changelog
Visit the [CHANGELOG](./CHANGELOG.md) file to see the changes over new version. Visit the [CHANGELOG](./CHANGELOG.md) file to see the changes over new version.