diff --git a/README b/README index e69de29..a571999 100644 --- a/README +++ b/README @@ -0,0 +1,42 @@ +README FILE + +eddsctrl_server +Benoit Dubois + +CONTENTS OF THIS FILE +--------------------- +* Introduction +* Requirements +* Installation + +INTRODUCTION +------------ +EDdsCtrl Server allow control of DDS AD9912 demo board through ethernet socket communication. + + ---------- + ------- (usb) | PC | (Eth) ---------- + | DDS |<-------->| EDds |<-------->| Client | + ------- | Server | ---------- + ---------- + +REQUIREMENTS +------------ +A Linux system with a Debian distribution (not tested with others distribs). +The program requires the folowing packages: + * Python 3.x (Normally already installed on a Debian system) + $ [sudo] apt-get install python3 + * dds package + See package for details on installation + +INSTALLATION +------------ +1. Install the Python binding +1.1 Untar the package archive + $ tar xvzf eddsctrl_server-x.x.tar.gz +1.2 Enter in the newly created directory + $ cd eddsctrl_server-x.x +1.3 Then install package + $ [sudo] python setup.py install + +Now you can start server: + $ eddctrlserver