SharpLink icon indicating copy to clipboard operation
SharpLink copied to clipboard

Documentation / Proper README

Open NovusTheory opened this issue 7 years ago • 7 comments

SharpLink needs a proper documentation / a better README that can document or some other means

NovusTheory avatar Jun 24 '18 16:06 NovusTheory

#15 updated the README but I'm not going to close this quite yet.

NovusTheory avatar Jul 29 '18 17:07 NovusTheory

Perhaps GitHub Wikis could be put to use?

devoxin avatar Jul 30 '18 19:07 devoxin

@Devoxin Please, and give more insight on how to use it and where to put the code

ghost avatar Aug 06 '18 21:08 ghost

cc @NovusTheory

devoxin avatar Aug 06 '18 21:08 devoxin

@xXFrostyXx Care to provide info on what's confusing to make it better?

NovusTheory avatar Aug 06 '18 22:08 NovusTheory

@NovusTheory Maybe what files people should make, or where to place certain bits of code, possible error fixes, the basic stuff so that people like me (even though i have fixed my errors) have a place to go to for some answers. Maybe some basic commands we could add, basically the basics but in a more simpler way.

ghost avatar Aug 06 '18 22:08 ghost

I don't see why a wiki would be needed. The library isn't massive enough for it. Most of the method names are self explanatory, everything can be found via Visual studio's intellisense (Not sure if VSCode has it). Even if you do need a wiki or documentation, read through library's code there are 2-3 main files.

Yucked avatar Aug 15 '18 03:08 Yucked