Skip to content

Commit

Permalink
Merge pull request #65 from norberttak/doc-update
Browse files Browse the repository at this point in the history
Doc update
  • Loading branch information
norberttak authored Jan 10, 2023
2 parents 4b673e4 + e6a6c63 commit 581a589
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Currently, it supports the bellow types of USB-HID devices:
6. [TRC-1000 PFD/MFD & Audio Panel](https://www.simkits.com/product/trc1000-complete-glass-cockpit/) These devices are replica of Garmin G1000 cockpit panels

## Configuration syntax
For configuration file syntax please see the document [here](doc/configuration.md)
For configuration file syntax please see the document [here](doc/configuration.md). It contains detailed description of different config options.

## Install
Get the latest release from [github](https://github.com/norberttak/XPanel/releases)
Expand All @@ -30,6 +30,8 @@ Copy the xpanel folder into your X-Plane plugin directory (in my case it is c:\X

Please don't forget to remove any other plugins that want to connect to your USB Hid devices in the home cockpit.

The aircraft specific configuration file (xpanel.ini) shal be put into the aircraft folder. You can see some here [example config files](https://github.com/norberttak/XPanel/tree/master/config)

If you have any errors during the plugin load or run please check the main X-Plane log file. If you want more detailed logs from the plugin, please set the log level to DEBUG or even TRACE. See the details at [config syntax](doc/configuration.md)

## Build
Expand Down
2 changes: 1 addition & 1 deletion doc/configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# XPanel v1.5 Configiration file format
# XPanel v1.6 Configiration file format
## General description
The configuration file format is _similar_ to the ini file format. It is divided into sections. A section can have properties. A section is marked by square brackets ([ ]). Every section shall have a unique id.
```ini
Expand Down

0 comments on commit 581a589

Please sign in to comment.