From 0ce92faf97e664051e7f57adb8ffc2e79f6b8a82 Mon Sep 17 00:00:00 2001 From: Jens Stigaard Date: Tue, 6 Aug 2024 08:00:16 +0200 Subject: [PATCH] Update CONTRIBUTION.md --- CONTRIBUTION.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index eedd453..0b0ede1 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -2,3 +2,31 @@ You can contribute to the library functionality by forking the project, cloning your fork to your own local machine, and push your changes to your fork, and finally, creating a pull request back to the main repository. + + +## Standalone project / Fork + +The code can be cloned and tested as needed from the source code. + +Clone the forked repository and go into directory +```sh +git clone https://github.com/jensstigaard/node-vmix.git +cd node-vmix +``` + +### Install dependencies (first time) + +```sh +npm install # or 'yarn' +``` + +Compile TypeScript source code to JavaScript + +```sh +npm run build # or 'yarn build' +``` + +Run tests +```sh +npm test # or 'yarn test' +```