doc: Added README.md
Signed-off-by: Philipp Le <philipp@philipple.de>
Change-Id: I985ebd8577a83d8ec621d746e21e3d29a277b109
diff --git a/README.md b/README.md
index e69de29..61feb0c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,86 @@
+# DCS Interactive
+
+Interactive Simulations and Visualizations for the Lecture in [Digital
+Communication Systems](https://github.com/pl33/dcs-lecture-notes) at
+the Otto-von-Guericke-University Magdeburg.
+
+## Installation
+
+Prerequisites:
+
+- Python 3.10+ must be installed on the system
+
+For Windows systems, ensure that Python is available in the PATH variable.
+
+For installation, execute in a terminal (the example shows a Bash terminal
+on Linux):
+
+```shell
+# 1. Create a virtual environment
+python -m venv dcs_venv
+# 2. Activate the virtual environment
+source ./dcs_venv/bin/activate
+# 3. Installation
+pip install dcs-interactive
+# 4. Deactivate the virtual environment
+deactivate
+```
+
+## Run the Application
+
+```shell
+# 1. Activate the virtual environment
+source ./dcs_venv/bin/activate
+# 2. Run it
+dcs-interactive
+# 3. Deactivate the virtual environment
+deactivate
+```
+
+## Troubleshooting
+
+### Application does not start
+
+Perhaps, an incorrect value has been set in an input field. Unfortunately,
+the application does not validate the values before saving, but before
+loading it from the permanent storage. This leads to an error. This bug
+is going to be fixed in future versions.
+
+**Solution:** Edit the permanent configuration storage or delete it. The
+storage can be found:
+
+- on Linux systems: `$HOME/.config/dcs_interactive/config.toml`
+- on Windows: `C:\Users\<username>\AppData\Roaming\Philipp Le\dcs_interactive\config.toml`
+
+## Screenshot
+
+
+
+## Contents
+
+The currently available simulations and visualizations are listed belows.
+The chapters correspond to the Lecture Notes of the Course [Digital
+Communication Systems](https://github.com/pl33/dcs-lecture-notes).
+
+- Chapter 2 - Time-Continuous Signals and Systems
+ - Phasor
+ - Fourier Series
+- Chapter 3 - Stochastic and Deterministic Processes
+ - Ergodic Process
+ - Cross Correlation
+ - Power Spectral Distribution
+- Chapter 4 - Sampling and Time-Discrete Signals and Systems
+ - Sampling
+ - Windowing
+ - Quantization Noise
+- Chapter 5 - Modulation and Mixing
+ - Modulation
+ - IQ Mixing
+ - QAM Modulation
+- Chapter 6 - Digital Signal Processing
+ - Digital Filter
+ - Digital Mixer
+ - Down Sampling
+ - Up Sampling
+- Chapter 7 - Spread Spectrum and Multiple Access
+ - Spreading
diff --git a/docs/screenshot.png b/docs/screenshot.png
new file mode 100644
index 0000000..1de46c7
--- /dev/null
+++ b/docs/screenshot.png
Binary files differ
diff --git a/setup.py b/setup.py
index 21842b6..2aaa6a2 100644
--- a/setup.py
+++ b/setup.py
@@ -12,6 +12,7 @@
name='dcs-interactive',
version='1.0.0',
description='Interactive Simulations and Visualizations for the Lecture in Digital Communication Systems',
+ long_description=open('README.md').read(),
author='Philipp Le',
author_email='philipp@philipple.de',
packages=['dcs'],
