hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 10:04:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
Matteo Perelli
2017-03-21 10:37:02 +01:00
parent c7554d3e8f
commit aa497d9ef4
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -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. Keep in mind that this command prerequisites are the sum of unit test and E2E tests.
##Documentation ##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` `yarn run docs`
to produce the documentation that will be available in the 'doc' folder. to produce the documentation that will be available in the 'doc' folder.