From ee53833f536757744836daadb3068d7eed9bebf2 Mon Sep 17 00:00:00 2001 From: Chay Choong Date: Wed, 5 May 2021 16:57:04 +0800 Subject: [PATCH] docs: adding README --- README.md | 35 +++++++++++++++++++++++++++++++++++ README.rst | 0 2 files changed, 35 insertions(+) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..6bbe62a --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# coveragepy-lcov + +This package provides a simple CLI for converting .coverage files to the LCOV format. + +# Usage + +```bash +pip install coveragepy-lcov + +# If the .coverage file is in your current working directory +coveragepy-lcov + +# Point to a different .coverage file path +coveragepy-lcov --data_file_path example/.coverage + +# Write the output to a different file path +coveragepy-lcov --output_file_path build/lcov.info + +# Use relative paths in the LCOV output +coveragepy-lcov --relative_path +``` + +# Configuration + +```text +Usage: coveragepy-lcov [OPTIONS] + +Options: + --data_file_path TEXT Path to .coverage file + --output_file_path TEXT lcov.info output file path + --config_file TEXT Path to .coveragerc file + --relative_path Use relative path in LCOV output + --preview Preview LCOV output + --help Show this message and exit. +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index e69de29..0000000