Skip to content

Commit 5e078c4

Browse files
committed
🎨 fix markdown warnings
1 parent 26e6f5c commit 5e078c4

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

generator/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Currently to generate the client you need to use the DIDx fork of OpenAPI generator and build the JAR yourself.
44

55
## Prerequisites
6+
67
```sh
78
# Clone projects
89
git clone https://github.com/didx-xyz/aries-cloudcontroller-python
@@ -17,9 +18,10 @@ mvn -B --no-snapshot-updates clean package -DskipTests=true -Dmaven.javadoc.skip
1718
```
1819

1920
## Generate the CloudController client
21+
2022
```sh
2123
cd aries-cloudcontroller-python
22-
pip install -r requirements.txt -r requirements.dev.txt
24+
pip install -r requirements.txt -r requirements.dev.txt --upgrade
2325

2426
./generator/scripts/generate-client.sh 0.9.0 # Or other ACA-Py version
2527
```

tests/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
### Running tests locally
1+
# Running tests locally
22

3-
In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project.
3+
In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project.
44

55
You can now run all tests py running `pytest` in the root of the project. in order to run specific tests you can specifying the test file to run, e.g. `pytest tests/path/to/your/testfile.py`. You can also run individual tests only using the `-k` flag of pytest `pytest tests/path/to/your/testfile.py -k 'test_your_whatever'` where `test_your_whatever` is the name of the test definition. For more information, please, refer to the [pytest docs](https://docs.pytest.org/en/).
66

7-
It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails.
7+
It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails.

0 commit comments

Comments
 (0)