Skip to content

Commit

Permalink
Update docs before release 0.1.0
Browse files Browse the repository at this point in the history
Add information about logging and classifier about windows OS
  • Loading branch information
WojtekMs committed Feb 9, 2024
1 parent 0d8cee2 commit 8533af2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/logging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Logging

Application supports logging to syslog and NTEventLog.

## Linux

To display application logs on linux run:

`journalctl -o cat -t matusiak_dev_banker`

This displays all logs from application including multiple runs. You can use standard journalctl flags to control
output.

## Windows

To display application logs on windows run:

1. search for "Event Viewer"
2. select "Windows Logs" in the tree on the left
3. select "Application" in the tree on the left
4. select "Filter Current Log..." in the options on the right
5. select "Event sources" and find "matusiak_dev_banker"
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ classifiers = [
"Programming Language :: Python :: 3.11",

"Operating System :: POSIX :: Linux",
"Operating System :: Microsoft :: Windows"
]
dependencies = [
"lxml",
Expand Down

0 comments on commit 8533af2

Please sign in to comment.