Skip to content

Commit 50eb716

Browse files
committed
docs: update README.md to clarify features and known issues
1 parent 4280327 commit 50eb716

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ X4 Log Watcher is a simple tool to monitor the log files of X4: Foundations. It
77
- Real-time log monitoring
88
- Filter log entries by regular expressions
99
- Multi-tabbed interface for filtering the same log file
10+
- Enable/disable filters on the fly per each tab
1011
- Watch not only the exact log file but also the parent directory to reload the log file when new log files are created
1112
- Support profiles saving and loading - i.e. current tabs with filters
1213
- Offline mode - i.e. load the log file from disk and parse it
1314
- Loading default profile on startup
15+
- Support a "Forced refresh" mode, if by some reason standard Windows file watcher doesn't work
1416

1517
## Requirements
1618

@@ -41,6 +43,12 @@ To use X4 Log Watcher, follow these steps:
4143
![Common errors parsing](docs/images/common_errors_parsing.png)
4244
![Exact ship monitoring](docs/images/exact_ship_monitoring.png)
4345

46+
## Known Issues
47+
48+
In some cases, the application may not detect changes in the log file. If this happens, you can enable the "Forced refresh" mode in the menu. This will force the application to check for changes in the log file at regular intervals.
49+
50+
Will work in case if any `watch mode` is enabled.
51+
4452
## Contributing
4553

4654
Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request.

0 commit comments

Comments
 (0)