search

Palsson123 / hitechbouncytechnologysystem

2 stars 0 forks source link

More documentation #1

Open jon-grangien opened 6 years ago

jon-grangien commented 6 years ago

I find the documentation a bit lacking in detail and scope thank you

Palsson123 commented 6 years ago

Hello Jonathan Gr-... Grangien (?),

thanks for opening an issue on our popular game that aspires to be the most played indie game about a ball, using bouncy technology system in 2018.

However, the team feels that it would help a lot if you could specify what you feel are missing in the documentation.

There is a great article about how to write a github issue that engages the community in the link below. https://wiredcraft.com/blog/how-we-write-our-github-issues/

jon-grangien commented 6 years ago

Good call my colleague, I will provide the details on the following paragraphes

Context: explain the conditions which led you to write this issue. There seems to be a bit of ambiguity amongst researchers what bouncy technology systems specifically refer to. Some may say that consensus claims that it is pseudo science; i.e. it is not rigorously defined in any known model. I propose a thorough documentation of the model, so that my peers and I can reach full understanding of the scope of this project.

Problem or idea: the context should lead to something, an idea or a problem that you’re facing. Neither I nor my peers could find a way to successfully install the game. How do we go on about installing it via something like the venerable npm, which is established as the so called "predominant factor" in the community.

Solution or next step: I would suggest more documentation, specifically on the scientific methods employed to make this the venerable product that it is, to ensure public adaptation and growth.

kantedal commented 6 years ago

I use ImGui as a dll by setting IMGUI_API to either export or import symbols appropriately - currently the addons are unusable for me because the interface (forward declarations of functions in headers) is not annotated with IMGUI_API accordingly.