From 063de2c215f9fbc82b53ea4dffc22c3272e89de4 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:39:27 +0200 Subject: [PATCH 1/5] 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). From 10aed85bd814a40ad4a742dc590f2a63374d08b4 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:42:46 +0200 Subject: [PATCH 2/5] FAQ: fix typos --- FAQ.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/FAQ.md b/FAQ.md index cc759fc3..2b0fc832 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,4 +1,4 @@ -# Frequently Asked Questios +# Frequently Asked Questions ## Start-up @@ -33,7 +33,7 @@ Instead, for documenting issues, please perform the steps mentioned in the next 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. +1. Hit the screenshot buttons (hotkey `F3` by default) 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. From bc6f7ed258f482df53024d08233556fe511b7c6d Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 12:45:26 +0200 Subject: [PATCH 3/5] FAQ: additional comments on downgrading --- FAQ.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index 2b0fc832..43172280 100644 --- a/FAQ.md +++ b/FAQ.md @@ -43,4 +43,7 @@ Besides describing it with words, you may do two things, which helps us reproduc ### 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`. +First of all, did you ensure that the bug is reported on our [issues page](https://github.com/it0uchpods/IDG-A32X/issues/new)? If no, please do so (see also questions above on how to report them)! + +Besides that, **never** downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file as well. You may find it in `$FGHOME/Export`. + From 9f6f084733ae6b9f8b5a3435e418a6277d7be389 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 20:38:32 +0200 Subject: [PATCH 4/5] Hints on simulation speed --- FAQ.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/FAQ.md b/FAQ.md index 43172280..c21e8ec5 100644 --- a/FAQ.md +++ b/FAQ.md @@ -47,3 +47,12 @@ First of all, did you ensure that the bug is reported on our [issues page](https Besides that, **never** downgrade your aircraft without resetting/deleting your `IDG-A32X-config.xml` file as well. You may find it in `$FGHOME/Export`. +### Q. I like increasing the simulation speed on long flights. However, I encounter issues with it once in a while. What's up? + +Increasing the simulation speed is quite tricky for the simulator. Depending on hardware capabilities it can be very stressful and the algorithms behind the scenes can be challenged quite heavily. If the simulation is running faster than the corresponding algorithms can be computed, many funny (or even [ugly things](https://github.com/it0uchpods/IDG-A32X/issues/86#issuecomment-478328407)) may happen. So, be careful with that. + +In general, one could say: + +* Don't increase the simulation speed above 4x. A simulation speed of 8x is already quite heavy load for everything. +* Check your frame rate (you are able to enable it in the "Debug" menu) when increasing the simulation speed. As a rule of thumb, if the frame rate stays constantly above 10fps, you are fine. Keep in mind that already one little phase (and not just the average) where the frame rate drops significantly, you are in danger facing issues. + From bbf03d8630d2a645b7f7dfd40ae40f55d6914194 Mon Sep 17 00:00:00 2001 From: Nico Schmoigl Date: Sun, 31 Mar 2019 20:47:31 +0200 Subject: [PATCH 5/5] FAQ: Correcting menu option for frame rate --- FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index c21e8ec5..546ccf70 100644 --- a/FAQ.md +++ b/FAQ.md @@ -54,5 +54,5 @@ Increasing the simulation speed is quite tricky for the simulator. Depending on In general, one could say: * Don't increase the simulation speed above 4x. A simulation speed of 8x is already quite heavy load for everything. -* Check your frame rate (you are able to enable it in the "Debug" menu) when increasing the simulation speed. As a rule of thumb, if the frame rate stays constantly above 10fps, you are fine. Keep in mind that already one little phase (and not just the average) where the frame rate drops significantly, you are in danger facing issues. +* Check your frame rate (you can enable showing it using the "View" menu, option "View Options", toggle "Show frame rate" there) when increasing the simulation speed. As a rule of thumb, if the frame rate stays constantly above 10fps, you are fine. Keep in mind that already one little phase (and not just the average) where the frame rate drops significantly, you are in danger facing issues.