add contributing + dev build sections

chrisweb · chrisweb · commit 11a5614feda4 · 2022-12-29T19:13:46.000+01:00
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-[![Dependencies](https://david-dm.org/chrisweb/waveform-visualizer/status.svg)](https://david-dm.org/chrisweb/waveform-visualizer)
-[![Dependencies](https://david-dm.org/chrisweb/waveform-visualizer/dev-status.png)](https://david-dm.org/chrisweb/waveform-visualizer)
+
 [![npm version](https://img.shields.io/npm/v/waveform-visualizer.svg?style=flat)](https://www.npmjs.com/package/waveform-visualizer)
 [![GitHub license](https://img.shields.io/github/license/chrisweb/waveform-visualizer)](https://github.com/chrisweb/waveform-visualizer/blob/master/LICENSE)
 
@@ -15,6 +14,62 @@ Waveform created using data that got generated using the [waveform data generato
 
 Check out the [simple waveform example](/examples/simple-waveform/README.md)
 
+## development: build
+
+install the latest nodejs (if you haven't already) [nodejs](https://nodejs.org)  
+
+install or update to the latest git version [git scm downloads](https://git-scm.com/downloads) (During installation at the step "choosing the default editor used by Git", if like me you are using visual studio code you might want to chose the new option "use visual studio code as Git's default editor") (also if like me you are on windows, at the step "adjusting your PATH environment", ensure the second radio button option is selected "git from the line and also from 3rd-party software" to ensure git is added to the windows PATH, which will allow you to use git with any command line tool like windows powershell for example)  
+
+git clone this repository to get a local copy  
+
+`git clone git@github.com:chrisweb/waveform-visualizer.git`
+
+open your favorite command line tool and go to the root directory of this repository  
+
+update npm to latest version  
+
+`npm install npm@latest -g`
+
+install the dependencies  
+
+`npm i`
+
+to build the distributions, use the following command:  
+
+`npm run build`
+
+in development you can use watch to have the build getting rebuild every time you edit code / save one of the typescript files  
+
+## development: watch
+
+`npm run watch`
+
+## development: linting
+
+to lint the typescript files  
+
+`npm run lint`
+
+## changelog
+
+3.0.0 removed UMD support, this and future versions will be ESM only
+
+## contributing (help / PRs appreciated 😊)
+
+you should first open a ticket and explain what fix or improvement you want to provide on the [github issues page](https://github.com/chrisweb/waveform-visualizer/issues) of this project (remember the github ticket number you will need it for the commit message later on)
+
+go the [github page of this project](https://github.com/chrisweb/waveform-visualizer) and hit the fork button  
+
+follow the instructions in the previous section ["development: build"](#development-build), but instead of cloning this projects repository, clone your own fork of the project  
+
+`git clone git@github.com:YOUR_USERNAME/waveform-visualizer.git`
+
+when you are done coding, commit your local changes (if your commit is related to a ticket start your commit message with the "#TICKER_NUMBER", this will "link" the commit to the ticket)  
+
+`git commit -m "#TICKER_NUMBER commit message"`
+
+now open your forks github URL in your browser and hit the pull request button
+
 ## license
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
