From 6bd8e71985de1b7613d7af967e0e3b5192eadcfb Mon Sep 17 00:00:00 2001
From: Ali Elnwegy <ali.el-nwegy@tuhh.de>
Date: Fri, 19 Jan 2024 11:35:15 +0100
Subject: [PATCH] merged changes

---
 README.md                                     |  46 ++++++++++++++++++
 .../DG2000_ProgrammingGuide_EN.pdf            | Bin
 .../DG2000_UserGuide_EN.pdf                   | Bin
 3 files changed, 46 insertions(+)
 rename DG2000_ProgrammingGuide_EN.pdf => manuals/DG2000_ProgrammingGuide_EN.pdf (100%)
 rename DG2000_UserGuide_EN.pdf => manuals/DG2000_UserGuide_EN.pdf (100%)

diff --git a/README.md b/README.md
index d0a93ec..bf35370 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 # Rigol DG2052 Python Library
 
 
@@ -90,3 +91,48 @@ For open source projects, say how it is licensed.
 
 ## Project status
 If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+=======
+# __\[fn_gen\]__ The Function Generator SCPI library in Python
+
+### Description: A library for usage with SCPI compliant function generators (for now the DG2000 series from rigol)
+### Usage:
+#### Linux
+
+```bash
+# Clone Repository and change to repo directory
+git clone https://collaborating.tuhh.de/ckn8479/fn_gen.git && cd fn_gen
+# Install virtualenv for python virtual enviroment management
+pip install virtualenv # Can be skipped if already installed
+# Create a virutal enviroment in repo folder called 'venv'
+python -m venv venv
+# Activate virtual enviroment
+source venv/bin/activate
+# Install python build package to build library
+pip install build
+# Build library
+python -m build
+# Deactivate virtual enviroment
+deactivate
+```
+#### Windows
+
+```powershell
+# Clone Repository and change to repo directory
+git clone https://collaborating.tuhh.de/ckn8479/fn_gen.git
+cd fn_gen
+# Install virtualenv for python virtual enviroment management
+pip install virtualenv # Can be skipped if already installed
+# Create a virutal enviroment in repo folder called 'venv'
+python -m venv venv
+# Activate virtual enviroment
+venv\Scripts\Activate.ps1
+# Install python build package to build library
+pip install build
+# Build library
+python -m build
+# Deactivate virtual enviroment
+deactivate
+```
+
+The library will be then available in `dist` as a `.whl` file.
+>>>>>>> 4cca64e (Added README.md and put manuals in a 'manuals' folder)
diff --git a/DG2000_ProgrammingGuide_EN.pdf b/manuals/DG2000_ProgrammingGuide_EN.pdf
similarity index 100%
rename from DG2000_ProgrammingGuide_EN.pdf
rename to manuals/DG2000_ProgrammingGuide_EN.pdf
diff --git a/DG2000_UserGuide_EN.pdf b/manuals/DG2000_UserGuide_EN.pdf
similarity index 100%
rename from DG2000_UserGuide_EN.pdf
rename to manuals/DG2000_UserGuide_EN.pdf