Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation / Proper README #13

Open
NovusTheory opened this issue Jun 24, 2018 · 7 comments
Open

Documentation / Proper README #13

NovusTheory opened this issue Jun 24, 2018 · 7 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@NovusTheory
Copy link
Collaborator

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

@NovusTheory NovusTheory added enhancement New feature or request help wanted Extra attention is needed labels Jun 24, 2018
@NovusTheory
Copy link
Collaborator Author

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

@devoxin
Copy link
Owner

devoxin commented Jul 30, 2018

Perhaps GitHub Wikis could be put to use?

@ghost
Copy link

ghost commented Aug 6, 2018

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

@devoxin
Copy link
Owner

devoxin commented Aug 6, 2018

cc @NovusTheory

@NovusTheory
Copy link
Collaborator Author

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

@ghost
Copy link

ghost commented Aug 6, 2018

@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.

@Yucked
Copy link
Contributor

Yucked commented Aug 15, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants