initial commit

1 files changed, 44 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ade1cb9
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+LeCrunch version 1.0
+====================
+
+Installation
+------------
+
+You must have h5py, a general-purpose Python interface to the Hierarchical
+Data Format Library version 5 installed. The source can be downloaded from
+<code.google.com/p/h5py>, or on an ubuntu distribution:
+
+~$ sudo apt-get install python-h5py
+
+Then just source the env.sh file in this directory, and you're good to go!
+
+What is LeCrunch?
+-----------------
+
+LeCrunch is a set or libraries and scripts for communicating and extracting
+waveform traces from LeCroy DSO oscilloscopes.
+
+How to use LeCrunch
+-------------------
+
+The syntax to fetch waveforms:
+
+~$ fetch.py <filename> [-n NUMBER OF TRACES] [-r NUMBER OF RUNS]
+
+where <filename> is the name of the file you would like LeCrunch to store the
+extracted waveforms; waveforms are stored in the hdf5 file format.
+
+Documentation
+-------------
+
+Currently, this README file is the only documentation.
+
+Bug Reports
+-----------
+
+Please send bug reports to <telatorre@gmail.com>
+
+That's all folks!
+-----------------
+
+--Anthony LaTorre <telatorre@gmail.com>
\ No newline at end of file