Update documentation

[vankasteelj]

• Contributing
  • Report bugs
  • Suggest enhancements
  • Submit PR
  • Translate
  • Contributor license agreement
  • links to code standards/git workflow/building-working
• Github
  • Issue template
  • PR template
• Code standards
  • Javascript
  • HTML
  • CSS
  • providers
  • streamers
• Git workflow
  • Commit messages
  • Clean up history
  • Tests
• Building/Working on butter
  • compatible platforms
  • requirements (node, npm, git)
  • instructions platform-specific (if needed)
  • what commands?
  • video tutorial (for windows users, not used to source code things)

see docs/rewrite branch

[vankasteelj]

Building

Compatible platforms:

Windows:

• 7, 8, 8.1, 10 (all flavors, x86 only (ie: no arm, also known as mobile), 32bits or 64bits)

Linux:

• Ubuntu >= 14.04 (what about 12.04? it might work with the LD_LIBRARY_PATH)
• Mint/Debian/Elementary?
• Fedora?
• Arch?
• Suse?
• CentOS?

OSX:

• = 10.9, only 64bits ?!? I don't know at all

Requirements

• NodeJS - https://nodejs.org

  • = 4

• NPM (make sure to install it with NodeJS)

  • = 3.0.0 (3 because we need to flatten the huge dep list)

• ~2G of free space
• git - win | deb: apt-get install git (note:win10 will have bash soon)

---

To build Windows Installer files:

• Nsis >= 3.0 - win | deb

Platform-specific instructions

blank

what commands?

npm install -g gulp-cli
npm install
gulp build
gulp run

[vankasteelj]

Butter Project trello board

Link should be added somewhere.

[vankasteelj]

JS code standards:

Should we indicate things like:

if you need to loop, prefer for (var i = 0, len = arr.length; i < len; i++) {} over other loops, like for (var i in arr) or arr.forEach()

?

[xaiki]

we prefer arr.forEach() and _.map()

[vankasteelj]

forEach is much slower, 100ms slower on 10.000 iterations, going exponentially slower as the iterations go up

[xaiki]

but is much clearer to read, don''t need to optimize unless it's a hotpath.