Menu
Next month my company is going to release one of of our technologies as an open-source project. We're now preparing the website, documentation and so on. The question I'd like to ask is:
Which open-source projects would you recommend as a reference of a well-documented, well-presented project?
We're looking for open-source projects which have good website presentation, documentation, tutorials, samples and so on. Projects we could learn from.
(A couple of words about our project, if it is relevant: it is a JavaScript library for web mapping, based on OpenLayers.)
My examples would be JQuery or Vaadin.
584
Yes, it is possible to make an open source project into a closed source project. The copyright holder can change the license of a project at any time, or cease to distribute source code of new releases. New releases can therefore be made closed source.
A successful open source project requires a lot of time and commitment. First of all the project must solve a problem, and solve it good. Developers are searching for good solutions for their problems. You must invest about 50% of the time into creating quality README.md and detailed documentation.
The Django framework is well-documented, has it's own book, a nice website, thorough contribution policy, and much more. What more could you want?
One nice thing to note (and I know a lot of other projects do this), is they include the docs as part of the trunk, so when someone submits a patch, they include the changes to the documentation at the same time. This really helps keeping everything in sync.
62
Which open-source projects would you recommend as a reference of a well-documented, well-presented project?
Qt 4. It is dual-licensed (commercial/LGPL), so it is technically not 100% pure opensource, but you can't beat documentation and tutorials.
33
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
