Skip to content

Commit 4b0e220

Browse files
committed
This section is an overview of mxdev usage.
1 parent 758ffcc commit 4b0e220

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/install/manage-add-ons-packages.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,11 @@ The generated files indicate from where the constraints were fetched, and commen
8484
You must perform that step.
8585

8686

87-
(manage-mxdev-example-files-label)=
87+
(manage-mxdev-usage-overview-label)=
8888

89-
### `mxdev` example files
89+
### `mxdev` usage overview
9090

91-
A minimal example set of files for `mxdev` would look like the following.
92-
{ref}`manage-common-management-tasks-label` customize your `Plone` instance.
91+
The default set of files for `mxdev` is shown below.
9392

9493
{file}`requirements.txt`
9594

@@ -100,7 +99,7 @@ A minimal example set of files for `mxdev` would look like the following.
10099
zope.testrunner
101100

102101
# Add required add-ons
103-
collective.easyform
102+
# collective.easyform
104103
```
105104

106105
{file}`constraints.txt`
@@ -130,23 +129,23 @@ collective.easyform
130129
; branch = feature-7
131130
```
132131

133-
With these three files in your project, you can generate package requirements and constraints files, and then install those packages.
132+
You can edit these three files in your project as you need.
133+
Then you can generate package requirements and constraints files, and then install those packages, with one command.
134134

135135
```shell
136136
make build-backend
137137
```
138138

139-
The `make` target invokes `mxdev`, which generates the files {file}`requirements-mxdev.txt` and {file}`constraints-mxdev.txt`.
139+
`make build-backend` invokes `mxdev`, which generates the files {file}`requirements-mxdev.txt` and {file}`constraints-mxdev.txt`.
140140
It then invokes `pip` to install packages with the new requirements file.
141-
Finally, to reload the packages, restart your Zope instance/Plone site with the following command.
141+
142+
To reload the packages, stop your Zope instance/Plone site with {kbd}`ctrl-c`, and start it with the following command.
142143

143144
```shell
144145
make start-backend
145146
```
146147

147148
```{seealso}
148-
This was a brief overview of how `mxdev` helps with versions and checkouts.
149-
It can do a lot more.
150149
See the [documentation of `mxdev` in its README.rst](https://github.com/mxstack/mxdev/blob/main/README.rst) for complete information.
151150
```
152151

0 commit comments

Comments
 (0)