diff --git a/README.md b/README.md index 3022a025..6430082b 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,31 @@ To embbed built-in drivers cargo run --features built-in-drivers cargo build --features built-in-drivers ``` + +## Report an issue + +To report an issue, the platform will provides you logs you can share to help us. + +```bash +# Run your platform with all logs and traces +cargo run -- -l -b -t +``` + +Then you can find the path where logs will be stored in your computer "Log dir" + +``` +---------------------------------------- +# Panduza Platform + +- Stdout logs : ENABLED +- Broker logs : DISABLED +- Debug logs : DISABLED +- Trace logs : DISABLED + +- Log dir : "C:\\Users\\Public\\panduza\\logs" +- Tree file : "C:\\Users\\Public\\panduza\\tree.json" +---------------------------------------- +``` + +Take the log of the day and join it with the issue +