search

selaux / miner-dashboard

Node.js based app to show the current status of your miner in a browser.
35 stars 15 forks source link

Improve documentation #47

Open selaux opened 10 years ago

selaux commented 10 years ago

@jedimstr: I've read that the documentation provided doesn't suffice. Any ideas how to improve it for a non-technical user?

jedimstr commented 10 years ago

I've been able to figure it out fairly easily, but then again, I'm pretty technical myself and am familiar with JSON, various programming languages, API's, white papers, etc.

For the less experienced techies out there, your existing docs would need more detailed JSON config examples for the modules showing various options/implementations. As it stands, your miner-dashboard would be somewhat difficult for anyone who hasn't setup a github clone, NodeJS, or anything of the sort (Python, compiler/IDE environments, etc).

For someone who's never seen JSON formatted files nor used any commandline/shell environment (Linux, Mac, even Windows/powershell), I'd say it would be quite a task, and possibly out of scope to bring them up to speed on basic skills before they would be able to attempt setting it up.

selaux commented 10 years ago

Adding documentation how to install miner-dashboard on the supported systems (Linux, Windows, MacOS) would be necessary as well I think...