Skip to content

wesleyan/cmdr-devices

Repository files navigation

cmdr-devices

This repository contains all of the device drivers that have been written for cmdr thus far.

cmdr is split into three parts: cmdr which contains the code for the daemon and the touch screen interface, cmdr-server which holds the backend/frontend code run on the central server, and the device drivers contained within this repo.

##Development notes ###Code style All code should match the following style: spaces for indentation and for aligning and line lengths should be minimized but there is no hard cut-off. For Ruby code, class names ShouldBeCamelCased, variable and method names should_be_underscored, every method and class should be documented using Yardoc tags and markdown formatting and RSpec tests should be written for all functionality.

For Javascript, the same formatting rules should apply, but variable and method names shouldBeCamelCased as well as class names. Methods and classes should be documented using JSDoc. Also, all code should be run through JSLint and any errors it identifies should be corrected (this means no global variables and semi-colons are mandatory).

In general, try to maintain the style already found in the code.

##License cmdr-devices is licensed under the GNU General Public License.