![ZCL Advanced Platform](src-electron/icons/zap_128x128.png)

# ZCL Advanced Platform

## Quick instructions

This is a node.js application. In order to run it, you need to have [npm](https://www.npmjs.com/) installed. Once you do, you can run:

```
npm install
```

which will download install all the project dependencies, and then run:

```
npm run zap
```

Refer to [more detailed instructions](docs/instructions.md) for more details.

## License

This software is licensed under [Apache 2.0 license](LICENSE.txt).

## Detailed Documentation

- [Design](docs/design.md)
- [Instructions](docs/instructions.md)
- [Coding standard](docs/coding_standard.md)
- [API](docs/api.md)
- [Release notes](docs/releasenotes.md)
- [FAQ](docs/faq.md)

![ZCL Advanced Platform](src-electron/icons/zap_128x128.png)

# ZCL Advanced Platform

## Quick instructions

This is a node.js application. In order to run it, you need to have [npm](https://www.npmjs.com/) installed. The best way is to simply download latest install of [node](https://nodejs.org/en/download/) and you will get npm. If you have an older version of node installed on your workstation, it may give you trouble, particularly if it's very old. So make sure you have decently recent (v12.16 or later as of 2020) version of node available. Run `node --version` to check what version is picked up.

Once you have a desired version of node, you can run:

```
npm install
```

which will download install all the project dependencies, and then run:

```
npm run zap
```

Refer to [more detailed instructions](docs/instructions.md) for more details.

## License

This software is licensed under [Apache 2.0 license](LICENSE.txt).

## Detailed Documentation

- [Design](docs/design.md)
- [Instructions](docs/instructions.md)
- [Coding standard](docs/coding_standard.md)
- [API](docs/api.md)
- [Release notes](docs/releasenotes.md)
- [FAQ](docs/faq.md

Add instructions about node, as you can run into a lot of trouble if you have ancient node version available on PATH.
Add instructions about node, as you can run into a lot of trouble if you have ancient node version available on PATH.
