Skip to content

Commit 288595b

Browse files
ajmay-awsJohn Tompkins
authored andcommitted
Update README.md (#228)
Added prerequisites for plugin installation.
1 parent 0f6fc53 commit 288595b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,19 @@ Usage
99

1010
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.
1111

12+
**Prerequisites**
13+
14+
- Python version 3.6 or above
15+
- Your choice of Java IDE
16+
- Lombok: The code generated by the CloudFormation CLI uses [Lombok](https://projectlombok.org/), which requires support in IDEs for some syntax highlighting to work. For the best development experience, it is recommended you install Lombok support in your IDE.
17+
18+
**Installation**
19+
1220
```shell
1321
pip3 install cloudformation-cli-java-plugin
1422
```
1523

16-
Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.
24+
Refer to the [CloudFormation CLI User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.
1725

1826
Development
1927
-----------

0 commit comments

Comments
 (0)