Skip to content

Commit e717857

Browse files
committed
chore(xfer): update README.md (#438)
Post-tranfer update of `README.md` Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent 92cac4d commit e717857

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1+
<!--
2+
© Broadcom. All Rights Reserved.
3+
The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
4+
SPDX-License-Identifier: MPL-2.0
5+
-->
6+
7+
<!-- markdownlint-disable first-line-h1 no-inline-html -->
8+
19
# Packer Plugin for VMware Desktop Hypervisors
210

3-
The Packer Plugin for VMware Desktop Hypervisors is a plugin that can be used to create virtual
4-
machine images for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro
5-
and VMware Workstation Pro.
11+
The Packer Plugin for VMware Desktop Hypervisors is a plugin for creating virtual machine images
12+
for use with VMware [desktop hypervisors][desktop-hypervisors], VMware Fusion Pro and VMware
13+
Workstation Pro.
614

7-
The plugin includes two builders which are able to create images, depending on your desired
15+
The plugin includes two builders for creating virtual machine images, depending on your desired
816
strategy:
917

1018
- [`vmware-iso`][docs-vmware-iso] - This builder creates a virtual machine, installs an operating
@@ -90,40 +98,39 @@ command `go build` from the repository root directory. Upon successful compilati
9098
To install the compiled plugin, please follow the Packer documentation on
9199
[installing a plugin][docs-packer-plugin-install].
92100

93-
### Configuration
101+
### Documentation
94102

95-
For more information on how to configure the plugin, please see the plugin documentation.
96-
97-
- `vmware-iso` [builder documentation][docs-vmware-iso]
98-
- `vmware-vmx` [builder documentation][docs-vmware-vmx]
103+
For more information on how to use the plugin, please refer to the [documentation][docs-vmware-plugin].
99104

100105
## Contributing
101106

102-
If you discover a bug or would like to suggest a feature or an enhancement, please use the GitHub
103-
[issues][issues]. Issues are monitored by the maintainers and are prioritized based on the
104-
criticality and community reactions.
107+
The Packer Plugin for VMware Desktop Hypervisors is the work of many contributors and the project team appreciates your help!
108+
109+
If you discover a bug or would like to suggest an enhancement, submit [an issue][issues].
105110

106-
Before opening an issue, please check existing open or recently closed issues to avoid duplicates.
111+
If you would like to submit a pull request, please read the [contribution guidelines][contributing] to get started. In case of enhancement or feature contribution, we kindly ask you to open an issue to discuss it beforehand.
107112

108-
When opening an issue, please include as much information as possible, such as:
113+
## Support
109114

110-
- A minimal reproducible example or a series of reproduction steps.
111-
- Details about your environment or deployment that might be unusual.
115+
The Packer Plugin for VMware Desktop Hypervisors is supported by the maintainers and the plugin community.
112116

113-
Please review the [contribution guidelines][contributing] before submitting a pull request.
117+
## License
114118

115-
For enhancements or features, please open an issue to discuss before submitting.
119+
© Broadcom. All Rights Reserved.
120+
The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
116121

117-
For comprehensive details on contributing, refer to the [contribution guidelines][contributing].
122+
The Packer Plugin for VMware Desktop Hypervisors is available under the [Mozilla Public License, version 2.0][license] license.
118123

124+
[license]: LICENSE
119125
[contributing]: .github/CONTRIBUTING.md
120126
[issues]: https://github.com/vmware/packer-plugin-vmware/issues
121127
[desktop-hypervisors]: https://www.vmware.com/products/desktop-hypervisor.html
122128
[docs-packer-init]: https://developer.hashicorp.com/packer/docs/commands/init
123129
[docs-packer-plugin-install]: https://developer.hashicorp.com/packer/docs/plugins/install-plugins
124-
[docs-vmware-iso]: https://developer.hashicorp.com/packer/plugins/builders/vmware/iso
125-
[docs-vmware-vmx]: https://developer.hashicorp.com/packer/plugins/builders/vmware/vmx
130+
[docs-vmware-plugin]: https://developer.hashicorp.com/packer/integrations/vmware/vmware/latest/
131+
[docs-vmware-iso]: https://developer.hashicorp.com/packer/integrations/vmware/vmware/latest/components/builder/iso
132+
[docs-vmware-vmx]: https://developer.hashicorp.com/packer/integrations/vmware/vmware/latest/components/builder/vmx
126133
[golang-install]: https://golang.org/doc/install
127134
[releases-vmware-plugin]: https://github.com/vmware/packer-plugin-vmware/releases
128-
[packer-plugin-vsphere]: https://developer.hashicorp.com/packer/plugins/builders/vsphere
135+
[packer-plugin-vsphere]: https://developer.hashicorp.com/packer/integrations/vmware/vsphere
129136
[download-vmware-ovftool]: https://developer.broadcom.com/tools/open-virtualization-format-ovf-tool/latest

0 commit comments

Comments
 (0)