diff --git a/src/ifctester/README.md b/src/ifctester/README.md index 5b3487675e..976d0d2482 100644 --- a/src/ifctester/README.md +++ b/src/ifctester/README.md @@ -4,6 +4,22 @@ With **IfcTester**, you can author and read **Information Delivery Specification ## How to use it +### Command line use + +.. code-block:: bash + + # run console reporter + python -m ifctester example.ids example.ifc + python -m ifctester example.ids example.ifc -r Html -o report.html + +Available flags: + +- ``-r`` / ``--reporter``: The reporting method to view audit results. Availabe reporters: Console, Txt, Json, Html, Ods, Bcf +- ``--no-color``: Disable colour output (supported by Console reporting). +- ``-o`` / ``--output``: Output file (supported for all types of reporting except Console). + +### Code example + ```python import ifcopenshell from ifctester import ids, reporter diff --git a/src/ifctester/ifctester/__main__.py b/src/ifctester/ifctester/__main__.py index c5c70cd9c2..05b2c6ec29 100644 --- a/src/ifctester/ifctester/__main__.py +++ b/src/ifctester/ifctester/__main__.py @@ -31,10 +31,10 @@ parser.add_argument( "-r", "--reporter", type=str, help="The reporting method to view audit results", default="Console" ) parser.add_argument( - "--no-color", help="Disable colour output supported by Console reporting", action="store_true" + "--no-color", help="Disable colour output (supported by Console reporting)", action="store_true" ) parser.add_argument( - "-o", "--output", help="Output file supported by Json reporting" + "-o", "--output", help="Output file (supported for all types of reporting except Console)" ) args = parser.parse_args()