Initial version of an FAQ page

This commit is contained in:
Nico Schmoigl 2019-03-31 12:39:27 +02:00
parent 0c5be65001
commit 063de2c215
3 changed files with 52 additions and 1 deletions

46
FAQ.md Normal file
View file

@ -0,0 +1,46 @@
# Frequently Asked Questios
## Start-up
### Q. `Error code: 0x223` is raised
You are most likely trying to start up the airplane in mid-air, for example on a final approach to a runway. This is [not possible with this aircraft](https://github.com/it0uchpods/IDG-A32X/issues/84#issuecomment-475035478).
The simulation is so complex that there is no support for starting it in mid-air. Therefore, please make sure that you start it on the ground, powering it up appropriately.
In case that you want to practice landing, it might be better to fly to your destination and by doing it using "touch-down" and "going around" (like real pilots do so, too).
## Reporting Issues / Debugging
### Q. Where should I report issues?
Please use our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new) to report bugs. Try to fill out the template there to the best of your knowledge.
### Q. I encountered a strange behavior while flying. Should I report a bug?
Yes, please do so! If we do not know about the bugs, there is no-one to fix them.
### Q. I have a flight recording which shows the problem. Could you please have a look?
I does not make sense sending in flight recordings, as they do not contain enough information. That is why they are more or less useless for us.
Properly enabling the recording is also not what is reasonable: The recording would be quite CPU and memory intensive and certainly would have a negative impact on your flight experience.
Instead, for documenting issues, please perform the steps mentioned in the next question:
### Q. I want to document an issue. What is the right approach doing so?
Besides describing it with words, you may do two things, which helps us reproducing your issue locally such that it can be debugged:
1. Hit the screenshot buttons often and send them all in! Five screenshots with redundant data isn't a problem to sort out, but one screenshot missing out which would have contained vital information may prevent understanding the problem properly.
2. If able you may also dump the property tree (see menu "Debug"). That is also a very helpful source of information.
## Do's and Don'ts
### Q. The current version has a bug, but I still want to keep flying. Can I downgrade?
NEVER downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file. You may find it in `$FGHOME/Export`.

View file

@ -1,5 +1,6 @@
<!-- Provide a general summary of the issue in the title above. -->
<!-- Issues are for reporting bugs or problems only. If you have a feature request, please write in the forums. -->
<!-- Did you already have a look into our FAQ page at https://github.com/it0uchpods/IDG-A32X/blob/master/FAQ.md ? -->
### Expected Behavior
<!-- Tell us what should happen. -->

View file

@ -12,3 +12,7 @@ Present pack includes the following Airbus A320 Family variants:
- A320-232
- A320-251N
- A320-271N
## Frequently Asked Questions
For answers on frequently asked questions, refer to our [FAQ page](./FAQ.md).