Commit 755e2b69 authored by Laurent Wouters's avatar Laurent Wouters
Browse files

[doc] Added documentation about build environment and linters

parent 27bffe3a17f1
...@@ -50,8 +50,29 @@ Doing so, the minimal working versions of node.js and npm are: ...@@ -50,8 +50,29 @@ Doing so, the minimal working versions of node.js and npm are:
* `node --version`: `v8.10.0` * `node --version`: `v8.10.0`
* `npm --version`: `3.5.2` * `npm --version`: `3.5.2`
## Access to build environment
The build environment can be invoked using the `cmd` script at the repository's root by passing the wanted command as a parameter to it.
The sources repository is mapped to the `/src` folder in the build environment.
For example, to execute the `build-src.sh` script in the context of the specified build environment (instead of the local host):
```sh
./cmd /src/build-src.sh
```
The `cmd` script tries to lookup the current folder relative to the repository's root in order to execute the requested command within the same folder.
It is then possible to execute:
```sh
cd extension
../cmd npm install
```
## Run linters ## Run linters
Linters for the components are called during the normal process.
It is also possible to manually invoke the configured linter as follow:
```sh ```sh
cd extension cd extension
../cmd run linter ../cmd run linter
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment