Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mp3monster committed Jul 3, 2024
1 parent f546a00 commit 26eac3c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ There are some functional gaps/needs that need to be addressed, and the plan is
Additions to be developed for the longer term:

- Regression test pack (Docker image?)
- Write the output in the same folder as the source file



#### Differences unlikely to be addressed

Expand Down Expand Up @@ -77,6 +78,10 @@ The generated file at the moment is placed in the local filesystem.

To keep things very simple logging is controlled directly to std out. But we can control whether the console output includes debug messages. This is done by setting an environment variable of `FLB_CONVERT_DEBUG` with the value `true`.

#### Reporting Logged Details to File

We can ask the converter to write the output information to a file (the output filename with a postfix of `.report`). This can be enabled with the environment variable `FLB_REPORT_FILE` set to a value of `true`.

## Supporting this project

To help make the utility better if you encounter configuration scenarios that the tool doesn't correctly translate, then please share them.

0 comments on commit 26eac3c

Please sign in to comment.