diff --git a/README.md b/README.md index 8a97fd7e2..e3d4fbc0a 100644 --- a/README.md +++ b/README.md @@ -257,6 +257,22 @@ We plan to push updates for each minor and major product release, allowing devel - [Theming guide](./imxweb/custom-theme/readme.md) - [CDR guide](./imxweb/projects/qbm/src/lib/cdr/Readme.md) +## Documentation + +There are two ways to install the documentation locally. The result will be stored in _\imxweb\documentation\_. + +### 1. Using Compodoc (preferred) +1. Install the Compodoc package globally by running `npm install -g @compodoc/compodoc`. +2. Navigate to the library to create documentation for (e.g. `imxweb\projects\qer`). +3. Run `compodoc -p tsconfig.lib.json` for a library or `compodoc -p tsconfig.app.json` for an application. + +### 2. Using npm only + +This method only works for `qbm`, `qer` and the applications. + +1. Navigate to _imxweb_. +2. run `npm run doc:` + ## Contributing We welcome and appreciate contributions. Here's how you can open a pull request to submit code changes.