From 063de2c215f9fbc82b53ea4dffc22c3272e89de4 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:39:27 +0200 Subject: [PATCH] Initial version of an FAQ page --- FAQ.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ ISSUE_TEMPLATE.md | 1 + README.md | 6 +++++- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..cc759fc3 --- /dev/null +++ b/FAQ.md @@ -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`. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 53e90f7d..6d670c46 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,5 +1,6 @@ + ### Expected Behavior diff --git a/README.md b/README.md index 050f3f8f..7b6f90c1 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,8 @@ Present pack includes the following Airbus A320 Family variants: - A320-214 - A320-232 - A320-251N -- A320-271N \ No newline at end of file +- A320-271N + + +## Frequently Asked Questions +For answers on frequently asked questions, refer to our [FAQ page](./FAQ.md).