From 5c3749570e5e86749d93c6c72d873aacd537c213 Mon Sep 17 00:00:00 2001
From: Ryan Tang <goluckyryan@gmail.com>
Date: Wed, 16 Mar 2022 21:20:52 -0400
Subject: [PATCH] Create README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5e3780
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Pixie16_GUI_DAQ
+This is a GUI DAQ for XIA Pixie16 digitizer.
+
+# requires 
+PlxSDK8.0+, installed at /usr/opt/PlxSdk
+PixieSDK 3.3, installed at /usr/opt/xia/PixieSDK
+CERN ROOT 6.0+ (using 6.24/06)
+
+The program is developing on Debian 10. using g++ 8.3.0, using Pixie16 16-bit 250MHz revision F.
+
+# make
+just $make, it will create object files and link all together to pixieDAQ
+it will also make test and example under testing folder.
+
+# Pixie16Class
+this is the main class for controlling the pixie16 digitizer. 
+It unfolds some control for the CHANNEL_CSRA. It likes a C++ wrapper for the C code for the PixieSDK. Before PixieSDK3.3, it also decode the data.
+
+# DataBlock
+this is a C++ class for a data Block, which is a Block for pixie output.