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

User Guide #750

Closed
yeastplume opened this issue Mar 5, 2018 · 9 comments
Closed

User Guide #750

yeastplume opened this issue Mar 5, 2018 · 9 comments

Comments

@yeastplume
Copy link
Member

With the abundance of switches, mining, and sync options in testnet2, the need for a more fully complete User Guide is becoming more apparent. Some discussion might be required in order to decide exactly where/how we want to achieve this and in what format (wiki, forum posts, etc). A lot of the information for the various options is scattered all over the place, it might just be a matter of collating them in a logical manner.

This would be a very, very helpful thing for someone who really wants to get more involved but doesn't necessarily have the coding background to take on.

@ignopeverell
Copy link
Contributor

A nice simplification would also be to get rid of the config file for most uses. Someone should be able to run a binary without having to worry about default config.

@0xmichalis
Copy link
Contributor

Or make grin generate the file with sensible defaults if not found.

@Bmwwallace
Copy link

I'm not a particularly skilled coder but I could collect all the data and information and and create a wiki for Grin if needed?
I could divide it into technical and non-technical sections and include the history of the development for those curious to understand its origins?

@quentinlesceller
Copy link
Member

@Bmwwallace
Copy link

Awesome thanks a mil, I'll start there and post a link to the wiki as soon as I have it up and running

@ignopeverell
Copy link
Contributor

No need for a new wiki, there's:

https://github.com/mimblewimble/docs/wiki

@Bmwwallace
Copy link

Ah perfect no problem at all. Would it be alright to do a Wikipedia article on it and explain the background to its development and perhaps give an overview of the mathematical and cryptographic elements to it? I think it would be great to bring it to as many platforms and forums as possible and give people a real understanding of the complexities :)

@ignopeverell
Copy link
Contributor

Sure.

@ignopeverell ignopeverell modified the milestones: Testnet2, Beta Mar 26, 2018
@ignopeverell ignopeverell modified the milestones: Beta / testnet3, Mainnet Jul 11, 2018
@yeastplume
Copy link
Member Author

Think we're okayish here with the wiki documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants