Skip to content

Commit

Permalink
Update CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jensstigaard authored Aug 6, 2024
1 parent 7841556 commit 0ce92fa
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
```

0 comments on commit 0ce92fa

Please sign in to comment.