From 72a2c0866156ebf3fea7bdb2ecec9cfad8af1764 Mon Sep 17 00:00:00 2001 From: David Glick Date: Tue, 26 Nov 2024 12:01:14 -0300 Subject: [PATCH] Update docs to use command --- .../{{ cookiecutter.__folder_name }}/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/backend_addon/{{ cookiecutter.__folder_name }}/README.md b/backend_addon/{{ cookiecutter.__folder_name }}/README.md index a6a68ac..5cb27e9 100644 --- a/backend_addon/{{ cookiecutter.__folder_name }}/README.md +++ b/backend_addon/{{ cookiecutter.__folder_name }}/README.md @@ -13,6 +13,7 @@ Install {{ cookiecutter.python_package_name }} with `pip`: ```shell pip install {{ cookiecutter.python_package_name }} ``` + And to create the Plone site: ```shell @@ -24,24 +25,22 @@ make create_site This package provides markers as strings (``) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone). These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`. -To use them, you need to use `bobtemplates.plone` version 6.3.4 or later, and run the following command. +To run `plonecli` with configuration to target this package, run the following command. ```shell -plonecli add -b .mrbob.ini content_type +make add ``` -The command passes the `.mrbob.ini` configuration file to `plonecli` to set some configuration variables which are needed to properly run the subtemplates. - -For example, you can add a behavior to your package with the following command. +For example, you can add a content type to your package with the following command. ```shell -plonecli add -b .mrbob.ini behavior +make add content_type ``` -You can add a control panel with the following command. +You can add a behavior with the following command. ```shell -plonecli add -b .mrbob.ini controlpanel +make add behavior ``` ```{seealso} @@ -49,7 +48,6 @@ You can check the list of available subtemplates in the [`bobtemplates.plone` `R See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI. ``` - ## Contribute - [Issue Tracker](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.python_package_name }}/issues)