Skip to content

Commit

Permalink
Update README and gitignore (#14)
Browse files Browse the repository at this point in the history
* Update README and gitignore

tool installation instructions and enhance command examples

* Fix comment about the poetry command
  • Loading branch information
barnett-yuxiang authored May 21, 2024
1 parent 6778dd5 commit 71cf0df
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# MacOS system files
.DS_Store

# VSCode settings directory
.vscode

# Generated reports
.coverage
coverage.xml
Expand Down Expand Up @@ -31,4 +37,4 @@ venv/
pyvenv.cfg
pip-log.txt
pip-delete-this-directory.txt
*.spec
*.spec
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ cover-agent \

You can use the example projects within this repository to run this code as a test.

Follow the steps in the README.md file located in the `templated_tests/python_fastapi/` directory, then return to the root of the repository and run the following command to add tests to the python fastapi example:
Follow the steps in the README.md file located in the `templated_tests/python_fastapi/` directory, then return to the root of the repository and run the following command to add tests to the **python fastapi** example:
```shell
cover-agent \
--source-file-path "templated_tests/python_fastapi/app.py" \
Expand All @@ -104,7 +104,13 @@ cover-agent \
--max-iterations 10
```

For an example using Go `cd` into `templated_tests/go_webservice`, set up the project following the `README.md` and then run the following command:
For an example using **go** `cd` into `templated_tests/go_webservice`, set up the project following the `README.md`.
To work with coverage reporting, you need to install `gocov` and `gocov-xml`. Run the following commands to install these tools:
```shell
go install github.com/axw/gocov/[email protected]
go install github.com/AlekSi/[email protected]
```
and then run the following command:
```shell
cover-agent \
--source-file-path "app.go" \
Expand Down

0 comments on commit 71cf0df

Please sign in to comment.