From 9bd4a670a9e3b015415f5129325aa83299aed893 Mon Sep 17 00:00:00 2001
From: xans <xans@noreply.localhost>
Date: Fri, 21 Nov 2025 21:17:46 +0100
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 917fe3c..733be1e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # MeasKit
+MeasKit is a python package for efficiently making control classes for test equipment operating on PyVisa.
+The classes can be largely described in simplistic markdown files and with very little structure a skeleton clas can be generated.
+
+## How to create a markdown file
+The markdown files are broken down in the following sections denoted by a single '#':
+```
+# LIBRARY COMMANDS
+# SETTEABLE PARAMETERS
+# GETTEABLE PARAMETERS
+# GETSETTEABLE PARAMETERS
+```
+
+Under library commands custom chains of multiple commands can be defined such as:
+```
+# LIBRARY COMMANDS
+
+- CONF_CHANNEL(channel,state,range,bandwidth,coupling)
+  1. recalls measured samples in the background and recall from memory
+  2. RMEM(1,nsamples)
+  3. READ
+```
+every command started with a '-'. Within every command you can use 3 numbers
+1 being a description
+2 being a generic command
+3 being a command with a return for the function