From aa497d9ef4d58ca2b3bdf6377053e3db83179fde Mon Sep 17 00:00:00 2001 From: Matteo Perelli Date: Tue, 21 Mar 2017 10:37:02 +0100 Subject: [PATCH] Readme update --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e490cef40..5dd357dd7d 100644 --- a/README.md +++ b/README.md @@ -150,7 +150,11 @@ To run all the tests (e.g.: to run tests with Continuous Integration software) y Keep in mind that this command prerequisites are the sum of unit test and E2E tests. ##Documentation -To build the code documentation we use TYPEDOC. Run: +To build the code documentation we use [TYPEDOC](http://typedoc.org). TYPEDOC is a documentation generator for TypeScript projects. +It extracts informations from properly formatted comments that can be written within the code files. +Follow the instructions [here](http://typedoc.org/guides/doccomments/) to know how to make those comments. + +Run: `yarn run docs` to produce the documentation that will be available in the 'doc' folder.