docs/bugs: v1 (#17)

* free only

Author: Byron Chris

.deepsource.toml

@@ -1,14 +1,16 @@
 <img src="https://user-images.githubusercontent.com/22690219/130872109-150ac61f-ad69-4bfb-8f10-3337abcb6551.png" alt="drawing" width="350"/> <img src="https://i.imgur.com/pJbgSUh.png" alt="drawing" width="350"/>
 
+[![Go Reference](https://pkg.go.dev/badge/github.com/bh90210/models.svg)](https://pkg.go.dev/github.com/bh90210/models)
+
 # elektron:models
 
-A Go package to programmatically interact with [elektron](https://www.elektron.se/)'s **model:cycles** & **model:samples** via midi.
+Go package to programmatically control [Elektron's](https://www.elektron.se/) **model:cycles** & **model:samples** via midi.
 
 ## Prerequisites
 
 ### Go
 
-Install Go https://golang.org/doc/install
+Install Go https://golang.org/doc/install.
 
 ### RtMidi
 
@@ -30,14 +32,32 @@ For more information see the [formulae page](https://formulae.brew.sh/formula/rt
 
 `Help needed.`
 
-## Usage
+## Quick Use
 
-_complete examples can be found in the [examples](https://github.com/bh90210/elektronmodels/tree/master/examples/) folder_
+_complete examples can be found in the [examples](https://github.com/bh90210/elektronmodels/tree/master/examples/) folder._
 
-The relevant cycles/samples manuals' part for this library is the `APPENDIX A: MIDI SPECIFICATIONS`.
+_The relevant cycles/samples manuals' part for this library is the `APPENDIX A: MIDI SPECIFICATIONS`._
 
 <img src="https://i.imgur.com/Yrs6YS3.png" alt="drawing" width="350"/> <img src="https://i.imgur.com/cmil9NG.png" alt="drawing" width="350"/>
 
-### Free
 
-### Sequencer
+Code to get a single kick drum hit at C4 key, with velocity set at `120` and length at 200 milliseconds:
+```go
+package main
+
+import (
+	"time"
+
+	m "github.com/bh90210/models"
+)
+
+func main() {
+	p, _ := m.NewProject(em.CYCLES)
+	defer p.Close()
+
+	p.Free.Note(m.T1, m.C4, 120, 200, m.PT1())
+	time.Sleep(200 * time.Millisecond)
+}
+
+```
+There are four Free methods to use, `Preset` to set preset on the fly, `Note` to fire a note on/off for given duration, `CC` to send a single control change message && `PC` for program changes. 

README.md

@@ -1,4 +1,4 @@
-package elektronmodels
+package models
 
 //
 // default presets

presets.go renamed to defaultpresets.go

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"time"
+
+	m "github.com/bh90210/models"
+)
+
+func main() {
+	p, err := m.NewProject(m.CYCLES)
+	if err != nil {
+		panic(err)
+	}
+	defer p.Close()
+
+	// reproduce helloSound example using Free API
+	var noteLength int = 250
+
+	defaultPresetT1 := m.PT1()
+	p.Free.Preset(m.T1, defaultPresetT1)
+	p.Free.Note(m.T1, m.C4, 120, float64(noteLength))
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+
+	p.Free.Note(m.T2, m.C4, 120, float64(noteLength), m.PT2())
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+
+	p.Free.Preset(m.T3, m.PT3())
+	p.Free.CC(m.T3, m.DELAY, 0)
+	p.Free.Note(m.T3, m.C4, 120, float64(noteLength))
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+
+	preset4 := m.PT4()
+	p.Free.Preset(m.T4, preset4)
+	preset4 = make(map[m.Parameter]int8)
+	preset4[m.DELAY] = 0
+	p.Free.Preset(m.T4, preset4)
+	p.Free.Note(m.T4, m.C4, 120, float64(noteLength))
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+
+	p.Free.Note(m.T5, m.C4, 120, float64(noteLength), m.PT5())
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+
+	p.Free.Note(m.T6, m.C4, 120, float64(noteLength), m.PT6())
+	time.Sleep(time.Duration(noteLength) * time.Millisecond)
+}

example/main.go

@@ -1,8 +1,10 @@
-module github.com/athenez/models
+module github.com/bh90210/models
 
-go 1.16
+go 1.17
 
 require (
 	gitlab.com/gomidi/midi v1.23.3
 	gitlab.com/gomidi/rtmididrv v0.11.0
 )
+
+require gitlab.com/gomidi/rtmididrv/imported/rtmidi v0.0.0-20191025100939-514fe0ed97a6 // indirect