Update Readme.md

Readme.md

@@ -11,18 +11,34 @@ Features now include:
 * IQ toolkit and IQ virtual channels -- Full suppport for single sideband modulation (Along with PM/AM/FM)
 * High speed uploader for Keysight PXI systems which supports upload during playback.
 
-TODO list:
-* Update virtual gate matrix function
-* Support for calibarion arguments? -- this should be engineered well.
-* HVI2 integration
-* add DSP module (must also be C++)
-
-TODO bugs and small things to fix,
-* deal with names and units of the loops + setpoints variable
-
 !! keysight AWG's their waveforms need to have a length of modulo 10 !! (related to the clock of the AWG)
 --> segments are concatenated for this purose when uploading (e.g. upload happens in one big chunk)
 
+# Requirements
+You need python3.x and a c/c++ compiler. For the c-compiler, the following is recommended
+* windows: the Visual Studio SDK C/C++ compiler (tested)
+* linux: gcc is fine.
+* ox x : gcc or clang both work
+
+If you want to install the upload libraries for the keysight system, you will need:
+* the Keysight SD1 software
+* openMP (comes by default in visual studio)
+
+# Quick start
+The pulse library can be installed by cloning the library from github on your computer.
+Navigate in the github folder and run the following in the terminal:
+```bash
+	python3 setup.py install
+```
+To install the uploading backend, you need to call:
+```bash
+	windows compilation under development
+```
+
+# Documentation
+Documentation for the library can be found at:
+https://qtwiki.tudelft.nl/pulse_lib
+
 # Initializing the library
 
 The general object that will manage all the segments and the interection with the AWG is the pulse object. The pulse object is best created in the station.
@@ -224,4 +240,12 @@ phase = 0
 seg.IQ.add_sin(t0,t1,freq, amp, phase)
 ```
 
-# working with calibarated elemements.
+# TODO
+TODO list:
+* Update virtual gate matrix function
+* Support for calibarion arguments? -- this should be engineered well.
+* HVI2 integration
+* add DSP module (must also be C++)
+
+TODO bugs and small things to fix,
+* deal with names and units of the loops + setpoints variable