| ... | ... | @@ -20,7 +20,7 @@ We have been selected as participating Orgs in the [2015](https://www.mbdyn.org/ |
|
|
|
### Some Frequently Asked Questions
|
|
|
|
|
|
|
|
#### Where can I find the developers' manual?
|
|
|
|
The short answer is: __there is no developers' manual__, sorry. A more detailed answer is: it is being authored; a draft copy is distributed within code in [`manual/tecman`](https://public.gitlab.polimi.it/DAER/mbdyn/tree/master/manual/tecman), but it's far from complete. Essentially, developers committed themselves to writing some technical documentation for each new feature that is added to the code, while features already implemented will get documented whenever they need review for whatever reason. Eventually, this document will become complete enough to be called "developers' manual".
|
|
|
|
The short answer is: __there is no developers' manual__, sorry. A more detailed answer is: it is being authored; a draft copy is distributed within the code in [`manual/tecman`](https://public.gitlab.polimi.it/DAER/mbdyn/tree/develop/manual/tecman) and the most recent version in PDF-format is distributed in [`tecman.pdf`](https://github.com/mmorandi/MBDyn-web/raw/main/userfiles/documents/tecman.pdf), but it's far from complete. Essentially, developers committed themselves to writing some technical documentation for each new feature that is added to the code, while features already implemented will get documented whenever they need review for whatever reason. Eventually, this document will become complete enough to be called "developers' manual".
|
|
|
|
|
|
|
|
#### How to Report a Bug?
|
|
|
|
The preferred method, since MBDyn moved to Gitlab, is to open an [Issue](https://public.gitlab.polimi.it/DAER/mbdyn/issues). Doing so will provide for better bug tracking and task assignments. Please make sure your request for help or bug report is well formulated. See Simon Tatham's ["How to Report Bugs Effectively"](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) or R. Clint Whaley's ["Why are you such a jerk when answering user questions? AKA: how can I help you feel good about providing me with support?"](http://math-atlas.sourceforge.net/faq.html#utone) for effective discussion of how help requests and bug reports should and SHOULD NOT be formulated. Many thanks to Simon and Clint for spelling out so clearly what we believe often are every free software developer's contrasting feelings with users. In general, before you post a request for help or report a bug, you should first:
|
| ... | ... | |
