SimpleServer/SimpleServer — Issue #210: Documentation and license
Author: bryanburke
Created: 2011-12-21 03:00:44+00:00
State: open

Just had a couple questions that I've been meaning to ask.

First, would anyone be interested in seriously beefing up the SimpleServer documentation, both for end users and developers? There's quite a bit of source in this project, but splitting up the documentation between several people would not be very difficult. I was thinking that developers could greatly benefit from "javadoc" documentation. End users could benefit from included documentation as well, especially since many server operators likely work in a CLI environment. I think that SimpleServer would be very much enhanced by exhaustive documentation.

Second, I understand the merits of including the copyright and MIT license texts at the beginning of every source file. However, with the growing number of source files in the project, would the other contributors be opposed to relying simply on a single LICENSE file and a COPYRIGHT file detailing the copyright and license for the entire project and the licenses of imported libraries (when applicable)? This would help centralize information about the project, especially if my first question above receives positive feedback.

Let me know your thoughts on these two fronts.