Deliverable D21.1 - ToC and guidelines

[Silvio Cretti]

Dear all,
I had a chance to talk with Jose Manuel Cantera about the ToC of the
Readme.md file and he approved what we I proposed. The only point is to add
a section on the API Documentation. So hereunder a recap of what to do for
preparing the deliverable:

   1. code on github
   2. README.md with the following ToC (of course some session are not
   mandatory):


   - Description (mandatory)
   - Features Implemented (mandatory) (list of feature implemented)
   - Installation Manual  (mandatory)
   - Installation Verification (Sanity Check)  (mandatory)
   - User Manual  (if applicable.  Either provide the content in the
   readme.md or in another file providing here the link)
   - API Documentation (if applicable. Provide here the content or a link
   to the API documentation, see below point 2)
   - Known Issues (if applicable)
   - License   (mandatory)
   - Reference  (if applicable)


   1. API documentation (when applicable) on Apiary. Please add also this
   information to the API:
   TITLE:
   DATE:
   VERSION:
   APIARY_PROJECT:<project_id>
   When done, please extract the documentation and put it into github
   (linking it from the Readme.md).


Deadlines are in the tickets you received.
As always for any question do not hesitate to contact me.
  silvio
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fiware.org/private/fiware-ops-dev/attachments/20150910/bcbc7217/attachment.html>