diff --git a/README b/README index a1a1985476799a4d76b28b7233bafddba3463160..2cf2c871ffc795fe783c6c984b5ae78f54256b51 100644 --- a/README +++ b/README @@ -1 +1,11 @@ -README file text goes here. +Welcome to the Open Ephys project! + +This GUI was designed to provide a fast and flexible interface for acquiring and visualizing data from extracellular electrodes. It's still lacking many features, and isn't yet robust enough for widespread release, but the overall framework will make it easy to extend. + +Everything is written in C++, with the help of the JUCE library (http://www.rawmaterialsoftware.com/juce.php). The JUCE library is lightweight, easy to learn, and completely cross-platform. What's more, it includes a variety of classes for audio processing, which have been co-opted to process neural data. It might be necessary to create custom data processing classes in the future, but for now, JUCE takes care of a lot of the messy bits involved in analyzing many parallel data streams. + +This repository contains all of the files you'll need to compile and run the GUIon Linux and Mac OS X. The makefile (for Linux) and XCode project (for Mac) are located in the Builds/ directory. + +If you want to add files, or create Windows binaries, you'll have to do that through "The Jucer," using the "open-ephys.jucer" file. The Juce library files, example code, and Jucer code are available on SourceForge: http://sourceforge.net/projects/juce/files/juce/ + +