Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 960 Bytes

readme.md

File metadata and controls

39 lines (28 loc) · 960 Bytes

#GuitarLib

Samples https://cmc19.github.io/GuitarLibTsSamples/

##Types##

  • Guitar Models a guitar, its strings, the tuning, and the available frets. Everything builds off of this class
  • GuitarString Models single guitar string and how its tuned
  • Strum
    • GuitarStrum
    • TabStrum implements ITabPart Used by TabDocument
  • TabDocument
  • abstract Scale
    • MajorScale models the Major Scale for the given Guitar

###UI

  • BaseUI
    • ChordView
    • GuitarNeck
    • TabView
      • TabEditor

##Build

  1. Ensure Environment is setup.
  2. run gulp in project directory

###Environment Setup

  1. install node
  2. install gulp
  3. Open command window in project directory
  4. Run npm install typescript-require gulp-sourcemaps typescript through2 gulp-rename gulp-uglify
  5. run npm install tsify browserify
  6. Run npm install vinyl-source-stream vinyl-buffer vinyl-transform
  7. run npm install del globby glob