From 39fe63fb2d535416b4c5f6a59fec055adf24ae9a Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Wed, 24 Oct 2018 13:06:03 +0300 Subject: [PATCH] README: Add development guidelines section Change-type: minor Signed-off-by: Thodoris Greasidis --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f09224ab..4459db8f 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,17 @@ If you're having any problems, check our [troubleshooting guide](https://github. You can also get in touch with us in the resin.io [forums](https://forums.resin.io/). +Development guidelines +---------------------- + +After cloning this repository and running `npm install` you can build the CLI using `npm run build`. +You can then run the generated build using `./bin/resin`. +In order to ease development: +* you can build the CLI using the `npm run build:fast` variant which skips some of the build steps or +* you can use `./bin/resin-dev` which live transpiles the sources of the CLI. + +In either case, before opening a PR make sure to also test your changes after doing a full build with `npm run build`. + License -------