Update readme to mention bundled addons and other things

This commit is contained in:
Ellwood Zwovic
2017-07-27 17:15:14 -07:00
parent 57ff2a5664
commit 20fa97f0d7

View File

@@ -12,6 +12,9 @@ change.
git checkout soc-2017-package_manager git checkout soc-2017-package_manager
2. [Compile](https://wiki.blender.org/index.php/Dev:Doc/Building_Blender). 2. [Compile](https://wiki.blender.org/index.php/Dev:Doc/Building_Blender).
2. You may want to build without addons (or delete them from `<build dir>/bin/<version>/scripts/addons*` afterwards).
This is because system addons typically can't be altered by the user (permissions), so the package manager won't be able to uninstall/update them.
Plus, the test repo only contains official addons, so if left as is, all addons will be installed already.
3. Clone the [package manager addon repository](https://developer.blender.org/diffusion/BPMA/repository): 3. Clone the [package manager addon repository](https://developer.blender.org/diffusion/BPMA/repository):
git clone git://git.blender.org/blender-package-manager-addon.git git clone git://git.blender.org/blender-package-manager-addon.git
@@ -21,7 +24,11 @@ change.
`/path/to/blender/build/bin/2.78/scripts/addons/` `/path/to/blender/build/bin/2.78/scripts/addons/`
5. Run blender 5. Run blender
6. Open the user preferences and switch to the "Packages" section. 6. Open the user preferences and switch to the "Packages" section.
7. Add a repository (currently only one is allowed, but this will change). You can use a local repository (see below), or the one I set up for testing: `http://blendermonkey.com/bpkg`. 7. Add a repository by clicking the "plus" icon on the left. You can use a local repository (see below), or the one I set up for testing: `http://blendermonkey.com/bpkg`.
Currently only one repository is allowed, but this will change.
### Repository creation
A local repository can be generated with the `generate_repository` script found A local repository can be generated with the `generate_repository` script found
in the addon repository. Example usage: in the addon repository. Example usage:
@@ -38,18 +45,15 @@ package to form the package's url (so for example, `http://localhost/node_wrangl
Things which are known to be bad, but are planned to get better Things which are known to be bad, but are planned to get better
* No progress display * No progress display
* No installed/available/upgradeable filtering
* Asynchronous operators can be run multiple times at once * Asynchronous operators can be run multiple times at once
* Not more than one repository can be used at once * Not more than one repository can be used at once
* Only the latest version of a package can be installed and uninstalled * Only the latest version of a package can be installed and uninstalled
# Notes # Notes
Packages which are installed on disk but aren't present in a known repository My intention is to eventually make uninstalls undo-able until blender is
are listed as 'installed' without an option to uninstall. This is so that it's restarted by moving the uninstalled files to a cache directory which is flushed
always possible to undo an uninstall. My intention is to eventually make uninstalls on startup and/or exit.
undo-able until blender is restarted by moving the uninstalled files to a cache
directory which is flushed on startup and/or exit.
Packages are identified by their name. This could of course cause issues if two Packages are identified by their name. This could of course cause issues if two
different packages end up with the same name. As it seems 2.8 will break many different packages end up with the same name. As it seems 2.8 will break many