diff --git a/.gitignore b/.gitignore index 57e0a92e4..584a516b6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,9 @@ +# MacOS system files +.DS_Store + +# VSCode settings directory +.vscode + # Generated reports .coverage coverage.xml @@ -31,4 +37,4 @@ venv/ pyvenv.cfg pip-log.txt pip-delete-this-directory.txt -*.spec \ No newline at end of file +*.spec diff --git a/README.md b/README.md index 774b96ebe..d8cc45493 100644 --- a/README.md +++ b/README.md @@ -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" \ @@ -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/gocov@v1.1.0 +go install github.com/AlekSi/gocov-xml@v1.1.0 +``` +and then run the following command: ```shell cover-agent \ --source-file-path "app.go" \