|
Title: Fixing Bitcoin Documentation Post by: super3 on June 15, 2013, 02:04:43 AM The Bitcoin docs (https://github.com/bitcoin/bitcoin/tree/master/doc) are pretty horrendous at this point. Before I added markdown most of the files were not even human readable. Right now I am focusing on cleaning up formatting, and then I will focus on actually trying to make some of it useful.
So far:
Would love to have some feedback on my changes, and what people would like added to the docs. After Cleanup 2 is in, I plan on adding a quickstart guide. Any ideas on what I should include in the quickstart guide would be appreciated. Title: Re: Fixing Bitcoin Documentation Post by: grue on June 15, 2013, 02:12:46 AM Quote from: doc/README.md You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu: Bitcoin runs fine for me on windows without dependencies.Also, I noticed you removed all the newlines. Is it customary for markdown files to contain long lines? It reads fine on github due to word wrap, but is it the standard for markdown viewers? Title: Re: Fixing Bitcoin Documentation Post by: super3 on June 15, 2013, 03:09:57 AM Quote from: doc/README.md You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu: Bitcoin runs fine for me on windows without dependencies.Also, I noticed you removed all the newlines. Is it customary for markdown files to contain long lines? It reads fine on github due to word wrap, but is it the standard for markdown viewers? |