Skip to content

Commit bec682e

Browse files
committed
Update documentation
- Add section on the `setup` script.
1 parent c66882c commit bec682e

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

chocolatey/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,18 @@ You can optionally provide the name of another configuration file when running t
2222
```
2323
*This will run the setup using the `./config/openShift.config` configuration file.*
2424

25-
The PowerShell version of the script `up.ps1` works the same way and may be used in an environment where PowerShell has already been used and configured.
25+
The PowerShell version of the script `up.ps1` works the same way and may be used in an environment where PowerShell has already been used and configured.
26+
27+
# Using the SetUp Script
28+
29+
The `setup.cmd` script can be used to integrate a specific version of the Chocolatey setup scripts into your project.
30+
31+
1. Copy the `setup.cmd` script into your project.
32+
1. Create a custom Chocolatey package file and place it in a `./config` directory relative to the `setup.cmd` script; `./config/</config>.config` for example.
33+
1. Update the defaults (`DEFAULT_CHOCO_CONFIG` for example) in the `setup.cmd` script to match your configuration.
34+
1. Commit the changes to your project.
35+
1. On the target system;
36+
1. Pull down a copy of your `setup.cmd` script and configuration.
37+
1. Run the `setup.cmd` script.
38+
39+
The script will download the versioned copies of the main `up` scripts, and install the packages defined in your configuration file after installing Chocolatey if needed.

0 commit comments

Comments
 (0)