documentation 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. * Documentation
  2. Although most of the concepts from Microsoft.NET can
  3. be applied to the completed Mono platform, we do need to
  4. have a complete set of free documentation written specifically
  5. for Mono.
  6. The documentation license we have chosen is the GNU Free
  7. Documentation License (FDL), the standard for most documents
  8. in the free software world.
  9. We need documentation on a number of topics:
  10. <ul>
  11. * The development tools (compilers, assembler tools,
  12. language reference, design time features).
  13. * Frequently Asked Question compilations.
  14. * HOWTO documents.
  15. * The Class Libraries
  16. * Tutorials on Mono and the specifics of running it.
  17. * A guide to Mono as compared to the Microsoft.NET
  18. Framework SDK
  19. </ul>
  20. ** Class Library documentation
  21. When contributing to the Class Library effort, please use the
  22. inline XML documentation tags to document your classes so we
  23. can automatically generate the documentation from the class
  24. libraries.
  25. If you provide examples, please do not embed them into the
  26. source code, as that will make the source code harder to read
  27. and maintain. Instead, put examples for your code into a
  28. subdirectory of the class libraries. Make your sample
  29. code a full standalone application that people can compile.
  30. Ideally the Mono documentation browser will let you edit, modify
  31. and run the sample programs.