Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.28 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.28 KB

overtones

A hands-on overtone synthesizer for building new tonal colors, built in Elm using the best of modern web technologies and functional programming.

This project was inspired by The Haskell School of Expression, especially the idea that the power of functional programming (and functional reactive programming) is well-suited for multimedia projects.

The eventual goal is to make this product platform-agnostic by wrapping it in Electron.

How to get started

  1. Make sure you have Node and NPM installed.

  2. Install dependencies

     npm install -g yarn
     npm install -g elm
     npm install -g elm-test
     yarn install
     elm-make --yes
    

(with building and running)

  1. Run the build

     yarn build
    
  2. Open dist/index.html in a browser. The entire contents of dist/ are what you want to host.

(with developing)

  1. Start the dev server with auto-building

     yarn start
    
  2. Open your browser to localhost:3000

  3. (Optional) Install VS Code (or your choice of text editor) with the VS Code elm extension (or the analogue for your text editor), along with the elm-format package (npm install -g elm-format) for a more robust IDE experience.