Complete README

bdubois
Showing 1 changed file with 36 additions and 0 deletions Side-by-side Diff
README
@@ -0,0 +1,36 @@
+README FILE
+
+eddsctrl_client
+Benoit Dubois
+
+CONTENTS OF THIS FILE
+---------------------
+* Introduction
+* Requirements
+* Installation
+
+INTRODUCTION
+------------
+A client for EDdsCtrl Server. The client provides UI to dialog with DDS controller server.
+Two clients availables:
+- an IHM constituted of an alphanumeric screen and some switchs (edds_client_panel),
+- a GUI developped in Qt (work in progress)
+
+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 install python3
+ * PyQt4 library
+          $ [sudo] apt install python3-pyqt4
+
+INSTALLATION
+------------
+1. Install the Python binding
+1.1 Untar the package archive
+          $ tar xvzf eddsctrl_client-x.x.tar.gz
+1.2 Enter in the newly created directory
+          $ cd eddsctrl_client-x.x
+1.3 Then install package
+          $ [sudo] python setup.py install
...	...	@@ -0,0 +1,36 @@
	1	+README FILE
	2	+
	3	+eddsctrl_client
	4	+Benoit Dubois
	5	+
	6	+CONTENTS OF THIS FILE
	7	+---------------------
	8	+* Introduction
	9	+* Requirements
	10	+* Installation
	11	+
	12	+INTRODUCTION
	13	+------------
	14	+A client for EDdsCtrl Server. The client provides UI to dialog with DDS controller server.
	15	+Two clients availables:
	16	+- an IHM constituted of an alphanumeric screen and some switchs (edds_client_panel),
	17	+- a GUI developped in Qt (work in progress)
	18	+
	19	+REQUIREMENTS
	20	+------------
	21	+A Linux system with a Debian distribution (not tested with others distribs).
	22	+The program requires the folowing packages:
	23	+ * Python 3.x (Normally already installed on a Debian system)
	24	+ $ [sudo] apt install python3
	25	+ * PyQt4 library
	26	+ $ [sudo] apt install python3-pyqt4
	27	+
	28	+INSTALLATION
	29	+------------
	30	+1. Install the Python binding
	31	+1.1 Untar the package archive
	32	+ $ tar xvzf eddsctrl_client-x.x.tar.gz
	33	+1.2 Enter in the newly created directory
	34	+ $ cd eddsctrl_client-x.x
	35	+1.3 Then install package
	36	+ $ [sudo] python setup.py install