Improve documentation for using and installing

[jwflory]

Hello!

Problem

Right now, there is not a whole lot of documentation or information for anyone who finds the project and wishes to use it. It's unclear whether there is a web platform a user could try out before setting it up, or if they have to install the server component themselves.

Analysis

Whether it's placed in the README ( #36 ) or in its own wiki page, having this information somewhere would be useful and helpful for bringing in more users to your project and helping them use your software, find bugs, etc.

In 1997, Richard Stallman wrote:

“The biggest deficiency in free operating systems is not in the software —
it is the lack of good free manuals that we can include in these systems.”

Something to consider. :)

Solution

There are a few ways you could tackle having helpful and useful documentation instructions.

• Distinguish between client and server instructions. Keep them either in separate pages or clearly separated sections of a page.
• Write installation instructions for any platform you are aware of that works – mostly considering Windows, OS X, and Linux as the big three.
• Breaking it down into numbered steps will not only help you write it, but it will keep the instructions focused and to the point.

[EroticD]

This project really needs this.

[socioboard]

The updated docs are here - wiki.socioboard.com , let us know if they are good enough for you to download/install/use.