Skip to content

Commit 5f3b96b

Browse files
PatMyronJohn Tompkins
authored andcommitted
README formatting (#208)
1 parent a9e5352 commit 5f3b96b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ This plugin library helps to provide Java runtime bindings for the execution of
77
Usage
88
-----
99

10-
If you are using this package to build resource providers for CloudFormation, install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk] and the (CloudFormation CLI Java Plugin)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin]
10+
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI](https://github.com/aws-cloudformation/aws-cloudformation-rpdk) and the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin)
1111

12-
```
12+
```shell
1313
pip3 install cloudformation-cli
1414
pip3 install cloudformation-cli-java-plugin
1515
```
@@ -19,15 +19,15 @@ Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-c
1919
Development
2020
-----------
2121

22-
First, you will need to install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk], as it is a required dependency:
22+
First, you will need to install the [CloudFormation CLI](https://github.com/aws-cloudformation/aws-cloudformation-rpdk), as it is a required dependency:
2323

24-
```
24+
```shell
2525
pip3 install cloudformation-cli
2626
```
2727

2828
For changes to the plugin, a Python virtual environment is recommended.
2929

30-
```
30+
```shell
3131
python3 -m venv env
3232
source env/bin/activate
3333
# assuming cloudformation-cli has already been cloned/downloaded
@@ -37,7 +37,7 @@ pre-commit install
3737

3838
Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit. The continuous integration also runs these checks. Manual options are available so you don't have to commit):
3939

40-
```
40+
```shell
4141
# run all hooks on all files, mirrors what the CI runs
4242
pre-commit run --all-files
4343
# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local

0 commit comments

Comments
 (0)