Changes between Version 2 and Version 3 of SoftwareDevelopment/ProjectGuidelines


Ignore:
Timestamp:
10/06/16 11:27:44 (8 years ago)
Author:
Twan Goosen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • SoftwareDevelopment/ProjectGuidelines

    v2 v3  
    1010* If applicable, '''document your API''', especially if its public facing. There are tools that make this easy, such as [http://swagger.io/ Swagger] (for Java)
    1111* Bundle some basic documentation with your sources 'and' distribution packages. Include at least the following:
    12  *`README` (brief project description)
    13  * `INSTALL` (setup and configuration)
     12 * `README` (brief project description, preferably with pointers to more detailed information)
     13 * `INSTALL` (setup and configuration instructions)
    1414 * `LICENSE` (source code licencing information)
    1515* Make a '''wiki page''' in the [https://trac.clarin.eu CLARIN Trac] for the software project or make a section for it in another page if that is more appropriate. This page can serve as a hub to find sources and technical, administrative and other information.