From 06e9bf210a9cfdb9d34719f2d74e7e531c117154 Mon Sep 17 00:00:00 2001
From: jupfi <github@jupfi.me>
Date: Mon, 24 Jun 2024 19:26:49 +0200
Subject: [PATCH] Added readme.

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c282a23..8bb5ff2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# quackseq
\ No newline at end of file
+# QuackSeq
+
+QuackSeq is a tool for programming pulse sequences for magnetic resonance experiments.
+
+The general  idea  is that different QuackSeq sequences can be run on either hardware spectrometers or software simulators.
+
+Different QuackSeq interpreters can be used to run the same sequence on different spectrometers or simulators.
+
+## Installation
+
+Create a new virtual environment and install QuackSeq:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install quackseq
+```
+
+## Modules
+
+- [quackseq-simulator](https://github.com/nqrduck/quackseq-simulator): A simulator for QuackSeq sequences.
+- [quackseq-limenqr](https://github.com/nqrduck/quackseq-limenqr): A QuackSeq interpreter for the LimeNQR spectrometer.