From 0572059c16cd4b453721c0363a6707c85b0628d0 Mon Sep 17 00:00:00 2001
From: Kingsley Collie <kingsley.collie@ukaea.uk>
Date: Tue, 4 Feb 2025 11:12:26 +0000
Subject: [PATCH] Convert README to markdown and add dev info

---
 .coverage           | Bin 0 -> 53248 bytes
 MANIFEST.in         |   1 -
 README => README.md |  31 +++++++++++++++++++++++++++++--
 dev/build.sh        |   3 ---
 dev/test.sh         |   3 ---
 5 files changed, 29 insertions(+), 9 deletions(-)
 create mode 100644 .coverage
 rename README => README.md (58%)
 delete mode 100755 dev/build.sh
 delete mode 100755 dev/test.sh

diff --git a/.coverage b/.coverage
new file mode 100644
index 0000000000000000000000000000000000000000..9fb70718efd6059093e0911c76158929f9320e4e
GIT binary patch
literal 53248
zcmeI)TWB0r7zgk(Gn;HS7pL0RHN@KUpr*0OZqs@}Ets@MtOjf~jm1m1v%4qB*xi|A
zW;RWPYPTu{L8xL;LG(pM5L*!XpjasQV!eS6nin5@utkgtf<<V>`klG#rR~c4Br*SC
zcXlr4oH^%rZacflKD1-h^aP)<ouc9KO>6~I6gI>;W2}RoUG$8WIBmqD9eP!2wi|7B
zu+&qJbm`-)v-Jh0@9ug)ALx9&>&A|+JBx|uJKl&Ji5#840s#m>00PTfpuD3qp6u>c
z4(|7iY(aRAkrPg^?%Mj`$ne+*9~<5>I>Livd|f-IWnh30bI0Dtr-j2O%!1&il{a&S
zXIhion-Wpzk}L9ZqN8Ip)yaS<Kfc_`n0bojiAhRg+A)iUGtc*m`F=k@cr{PVdBFin
zM3|G748hlh(fha~CWIrboN$9&tTXd{?S0QY-5yV_T&Wxqewhp>M~{xW($IlwQMOG`
zLOI*X%iL!j!^%wwx1Sr866S2m=bRUm*0GCe&*lZw@{4J?rf1p~7jq(4@<jf!1?-n-
z(L#8&rJ=O;$O7#NVushM(WyqhOw2HN7<qy+XW0>JHKM#UMfUS-m5Ny+f1*^JmX$*>
zf(v_gqnM52dUjaYrt9W1by+QMU3Es}vPOegCCi*CiAv@7^J>g~zZjO?&t)N~1>Dfl
zn!J6b!l+e>Id`T&@3%5W$+P|a3{`$+kXD_~UfC8;u3f7fn(-To<jG`B&#i1E>KaYu
zaD%2J&o^#2vX|6164{Fi1#VCHT}H;{LFG_uuI)4F2*Yq>N8@%FkaGH;wl<kr$^*|9
z>}-8o^IME7sDsd05CxkkSvlENTv>*kJu4hzQl!GO!LaaOHzaC0gNfGU$l69tr_uy6
zgO$zpa(8Py+0&yOO!&<xtgY}RUe|=8n!L;~8l5T%!!0?{K=Mz6WE7)1N=AJoJVV79
zh_@z(dm0rd43`-UH`>baSUkCUwNegxgdCUTv!$*O@<_D{Tr?3hpZ#gWo8p(|T^^>4
z_qMbq?_Av|<1!1GLAh>y=26wp@}X{Dzet0=d}?)BmPe{tzF*7_%o+t6O{NXgp)N~f
za4-XK88B~9U?XdnJiq<QUB7wCxu=@nAc5+BWKW^`{NU8Rx7)63(zGh4E%%P-DDRyz
zTsaE4y*z8%1z}jh+(0q5xpYm_<$fM6ot5sYrs2-ZG$v<z{X9jJiyY?1sMAILi#Ccy
z!^(&Am7IoyRB7y&ol{;X7(^%{@1;)ZQWw1_%_!0EtQ@hT^i$JhB2z6I`JlVYN~uY4
z-;}r{xnMTB+wg>E76q3<{LJ_bYoForoFnKY&82<4+CMb|SzDPwxt4dyZSt*Ld94yp
zu3xW|OJQdW#+i&ulX}sJvK{WKb&cerlhyX}01deGZl|`LNV^&ixf@(T4sJmWW&?#N
zRQO(}y-(iYEBbjx4=fOX00bZa0SG_<0uX=z1Rwwb2>ky9G(}b7^8R1dzi0Zdw88=b
z2tWV=5P$##AOHafKmY;|fWVRz=v1{edh{0_8&)V<Pj~n?0Jo)XO$}~nr&6i<k4*nj
zKf5Fgh)hEO0uX=z1Rwwb2tWV=5P$##AW#wL)Yd4`#{g=(){_W71(4tW$Mls<Kc&B{
zKTI1~AOHafKmY;|fB*y_009U<00PTHU`s5<%8B%pT@>lPIlE9W1^wtrUZl6(J-Wp)
z^OGWN<_p<i%M-5WrsbM`BquybKSOY*rm_A1Dv3<Sv`jCPp~#z5jTM`WoS~lz5)^0d
z7DZz-%|@zTOMd?!(^oP5GyRCZi#D)800Izz00bZa0SG_<0uX=z1eS@w)>t{AG<hrC
z;Ql|hS=;~blBl`=*KXE|%|@==|EsrXGtGWzQFAT){@*fb)F>tdAOHafKmY;|fB*y_
z009UrR{@RwVxUWY|F7tOGJ0Tv00bZa0SG_<0uX=z1Rwwb2teR}D4=Ow3IG59ulSki
z-|OT0C~aVY00bZa0SG_<0uX=z1Rwwb2rO}d-LV!WQQjP5Z1egzSABNV=O6U@kB@7Y
zgGa~T-?;b4&iBUOKmP3_d*$l$(&NV#ODB#loc(C`!s3&1=fkm`$A3CMwsU9c?74I2
z7LP3~o?VQ$X)z^nl}7(iUyiGEse@OjYTGbZ+Bh5KI&Dv@?7+}T_3%6Fj|*|-nijU=
ziyubV&`Yb?r}y0Vu6pv57kf{A({b`UXVrnx!B^Jwz51K_MgHY$XP@hQ^2F|A3ms$W
z!|5UItpjRM5iQ}%F6F|Z1ApntF7{4p)3z_K|7PIGYvQZ7H;VFOS6`>Z5{V(o($73`
zn8`;F>E7Ul2mk+nhUw?^-}PVgGr?i3ApijgKmY;|fB*y_009U<00IzLdIGKV!Gscv
z`7fI0zo=@AJ{j=8|7R<fUWt%n2tWV=5P$##AOHafKmY;|fB*!V7m(lo<Nm*SFNA~u
z1Rwwb2tWV=5P$##AOHafEJcCf_y12b{q$1IJ@O0z2tWV=5P$##AOHafKmY;|fIvl{
cTh-X@Tj#wg+e&S<XN6--iq!T(Y0|X*2IYrC`v3p{

literal 0
HcmV?d00001

diff --git a/MANIFEST.in b/MANIFEST.in
index 33f21da..8da5b21 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,2 @@
 include README.md MANIFEST.in setup.py .gitignore
 recursive-include idlbridge *.py *.pyx *.pxd *.pxi *.pro VERSION
-recursive-include dev *
diff --git a/README b/README.md
similarity index 58%
rename from README
rename to README.md
index 3de4a3f..dc3eb27 100644
--- a/README
+++ b/README.md
@@ -1,5 +1,4 @@
-IDLBridge
-=========
+# IDLBridge
 
 A python wrapper for the IDL.
 
@@ -18,6 +17,34 @@ without requiring significant code refactoring.
 
 - Dr Alex Meakins (alex.meakins@ukaea.uk)
 
+# Installation
 
+First ensure the `IDL_DIR` environment variable is set to the path to the IDL
+installation root (containing `/bin` and `/external`). `IDLBridge` can then be
+installed from [PyPI](https://pypi.org/):
 
+```bash
+pip install idlbridge
+```
 
+# Development
+
+## Build source distribution
+
+First install `build`:
+
+```bash
+pip install build
+```
+
+Then build the source distribution, note `IDL_DIR` must also be set for this:
+
+```bash
+python -m build --sdist .
+```
+
+## Run tests
+
+```bash
+python -m unittest
+```
diff --git a/dev/build.sh b/dev/build.sh
deleted file mode 100755
index 45914c2..0000000
--- a/dev/build.sh
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/bin/bash
-
-python setup.py build_ext --inplace --force
diff --git a/dev/test.sh b/dev/test.sh
deleted file mode 100755
index a53191b..0000000
--- a/dev/test.sh
+++ /dev/null
@@ -1,3 +0,0 @@
-#!/bin/bash
-
-python -m unittest