リリースドキュメントを整理

[trx-305dsp/dsp.git] / hirado / README

diff --git a/hirado/README b/hirado/README
new file mode 100644 (file)
index 0000000..a548c83
--- /dev/null
+++ b/hirado/README
@@ -0,0 +1,24 @@
+README
+ Created on: 2015/Aug/21
+     Author: Takemasa Nakamura
+
+* What is this
+This is the source tree of the "Hirado" framework. The Hirado framework is the SDR 
+framework on the ADSP-BF533 of TRX-305 SDR sytem.
+
+The framework contains the entire software to control the DSP which includes :
+- SPORT communication
+- DMA handling
+- Logging on UART
+- Performance measurement  
+
+Also, the programmer can modify the demodulator.h to implement his demodulation algorithm
+
+* How to get it
+The newest source code and documentations is placed on http://osdn.jp/projects/trx-305dsp/
+
+* How to build it
+To build it, run the installer on the development OS. The installer is also placed on the 
+above WEB site. Once the tool is install it, run "configure_project" script in this directly. 
+And then, run make.  
+