==========================
Spectral Workbench
Copyright 2011-2013 Public Laboratory
publiclaboratory.org | spectralworkbench.org
==========================

Spectral Workbench is a set of open-source tools to perform low-cost spectral analysis and to share those results online. The suite is provided in several folders, each corresponding to a separate tool:

/webserver - A Ruby on Rails web application for publishing, archiving, discussing, and analyzing spectra online.
	- running at http://spectralworkbench.org; the primary way to use Spectral Workbench
/ios - A PhoneGap-based native iOS app currently under development in the 'ios' branch
/spectrometry_kit - A (deprecated) Processing.org-based desktop environment for collecting spectral readings from a connected USB webcam-based spectrometer.

Read about how to build and use your own spectrometer with this software here: http://publiclaboratory.org/tool/spectrometer

==========================
LICENSE
==========================

Spectral Workbench is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Spectral Workbench is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Spectral Workbench.  If not, see <http://www.gnu.org/licenses/>.

==========================
INSTALLATION
==========================

These instructions are for the webapp in /webserver/ only:

The app requires Ruby 1.8.7 and Rails 2.3.15.

Thanks to YvesAD, there is a rough but detailed installation guide here: https://gist.github.com/YvesAD/5520784

However, instead of individually installing gems with "sudo gem install blablabla", you should be able to run "rake gems:install". 

This was based on his work in the Github issue here: jywarren#206

Installation is not very straightforward, but we hope to improve it soon.

==========================
BUGS AND SUPPORT
==========================

To report bugs and request features, please use the GitHub issue tracker provided at https://github.com/jywarren/spectral-workbench/issues 

For additional support, join the Public Laboratory website and mailing list at http://publiclaboratory.org or for urgent requests, email web@publiclaboratory.org

==========================
DEVELOPERS
==========================

Development is occurring at https://github.com/jywarren/spectral-workbench/; please fork and submit pull requests.