Skip to content

Commit

Permalink
docs(readme): add debug instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Curve committed Dec 15, 2023
1 parent 530c7c2 commit 8a9eafc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ The Rest-Server exposes three simple endpoints
pnpm install
```

## 🐛 Debugging

When reporting an issue please make sure to set the environment variable `VENMIC_ENABLE_LOG`.

If said variable is set venmic will output a lot of useful information to stdout and a log-file which can be found in `~/.local/state/venmic/venmic.log`.

It is highly recommended to include this log file in your issue report otherwise we may not be able to help you!

## 🤝 Acknowledgements

This project heavily relies on the following projects:
Expand Down

0 comments on commit 8a9eafc

Please sign in to comment.