search

richelbilderbeek / djog_unos_2018

Project by the Uno's at DJOG 2018-2019: Nature Zen
GNU General Public License v3.0
6 stars 2 forks source link

manual as doc and GitHub wiki #488

Open richelbilderbeek opened 5 years ago

richelbilderbeek commented 5 years ago

Is your feature request related to a problem? Please describe.

Currently, our game is undocumented. Players expect a manual.

[edit: we voted for these two ways]:

Features

Option Pro Con
Markdown Simple, can be used in-game No Wiki capabilities
GitHub wiki No extra account needed, only Team Octane members can edit Cannot be used in-game directly
Wikia wiki Get rid of the shackles of GitHub :smiling_imp: Need Wikia account, cannot be used in-game directly

Describe the solution you'd like

Vote for the option you like, you can vote a yes/no per topic.

Option Yes/No
Markdown Y/N
GitHub wiki Y/N
Wikia wiki Y/N

Describe alternatives you've considered

None.

Additional context

None.

richelbilderbeek commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki N

I enjoy GitHub :octocat:

DynCoder commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki N

I would like the wikia purely for extra information like any other wikia, not as a tutorial.

AramPetiet commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki N
Wikia wiki N

Its the easiest tojust have it in game so people dont have to go on a alt screen to look how to play

same-drenth commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki N
DynCoder commented 5 years ago

Please note that the manual will also be uploaded to steam and that there is a difference between manual and tutorial.

richelbilderbeek commented 5 years ago

I can convert a Markdown file to PDF with easy, as I do to create the Arduino/Processing/mBot booklets. Else there are plenty of Qt classes that can help us out :rainbow:

rijkvp commented 5 years ago
Option Yes/No
Markdown N
GitHub wiki N
Wikia wiki Y
martprenger commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki N
RafayelGardishyan commented 5 years ago
Option Yes/No
Markdown N
GitHub wiki Y
Wikia wiki Y

I enjoy GitHub :octocat:, like @richelbilderbeek

robkruger commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki Y
DynCoder commented 5 years ago

Conclusion: Both as Markdown and GitHub wiki

martprenger commented 5 years ago
Option Yes/No
Markdown Y
GitHub wiki Y
Wikia wiki N
DynCoder commented 5 years ago

Mart your vote is two weeks late, it doesn't count anymore

DynCoder commented 5 years ago

Also, you already voted