CONTRIBUTING.md

Contribution

Setup

running the following to get started:

curl -o- https://raw.githubusercontent.com/wslutilities/wslu/develop/scripts/install.sh | bash

Build Structure

wslu
|-src
|  |-mime/wslview: mime file for wslview
|  |-etc
|  |  |-wsl.ico: default icon for wslusc
|  |  \-runHidden.vbs: script for wslusc
|  |-wslu-header: Header file of all script
|  \-<components>.sh: Components of script
|-scripts: scripts used for building, installing and uninstalling
|-tests: location for script tests
\-extras
   |-bats: testing utility
   \-debian: stuff for 

Build

run make to build executable to out folder. run make clean to clean out folder. run make test to run tests.

Test

wslu use bats for testing. Please refer to its guide to write tests.

Build Packages

For Debian Package, run:

cd script
sudo ./builder-deb.sh

For RPM Package, run:

cd script
sudo ./builder-rpm.sh

It is suggested to do such action in Ubuntu 14.04 LTS or its corresponding environment.