Move docs to doc folder

README.md

@@ -2,34 +2,7 @@
 
 Core bluesky plan stubs & devices for use at ISIS. Not instrument/technique specific.
 
-### Local development
+### Documentation
 
-Create & activate a python virtual environment (windows):
-
-```
-python -m venv .venv
-.venv\Scripts\activate
-```
-
-Install the library & dev dependencies in editable mode:
-```
-python -m pip install -e .[dev]
-```
-
-Run the unit tests:
-```
-python -m pytest
-```
-
-Run lints:
-```
-ruff format --check
-ruff check
-pyright
-```
-
-### Release Process
-
-Releases are created automatically via a github action, to create a release just create a new git tag on the commit on main (i.e. `git pull`, `git checkout main` `git tag <release.version.number.` `git push origin tag <release.version.number.`) This will start a workflow that will check that all linters and tests pass, and then publish a new release with the version number specified in the tag to [Pypi](https://pypi.org/project/ibex-bluesky-core/0.0.1/) and github. The new release can then be installed via `pip install ibex_bluesky_core`. The workflow must be approved by someone in the ICP-Write group. To do this go to the action (Actions -> the action on the tag) and approve it.
-
-Credentials for Pypi can be found on keeper.
+See `doc/` folder for developer and user information e.g. how to set up a development 
+environment or how to create a release.

doc/create_a_release.md

@@ -0,0 +1,21 @@
+### Release Process
+
+Releases are created automatically via a github action. 
+
+To create a release just create a new git tag on the commit on main:
+```
+git pull
+git checkout main
+git tag <release.version.number>
+git push origin tag <release.version.number>
+```
+
+This will start a workflow that will check that all linters and tests pass, 
+and then publish a new release with the version number specified in the tag to 
+[Pypi](https://pypi.org/project/ibex-bluesky-core/0.0.1/) and github. The new 
+release can then be installed via `pip install ibex_bluesky_core`. 
+
+The workflow must be approved by someone in the ICP-Write group. To do this go 
+to the action (Actions -> the action on the tag) and approve it.
+
+Credentials for Pypi can be found on keeper.

doc/set_up_dev_environment.md

@@ -0,0 +1,41 @@
+### Local development
+
+Create & activate a python virtual environment (windows):
+
+```
+python -m venv .venv
+.venv\Scripts\activate
+```
+
+Install the library & dev dependencies in editable mode:
+```
+python -m pip install -e .[dev]
+```
+
+Run the unit tests:
+```
+python -m pytest
+```
+
+Run lints:
+```
+ruff format --check
+ruff check
+pyright
+```
+
+Run the 'demo' plan:
+
+```
+python -c "from ibex_bluesky_core.demo_plan import run_demo_plan;run_demo_plan()"
+```
+
+If PVs for the demo plan don't connect, ensure that:
+- You have set an `EPICS_CA_ADDR_LIST`:
+```
+EPICS_CA_ADDR_LIST=127.255.255.255 130.246.51.255
+EPICS_CA_AUTO_ADDR_LIST=NO
+```
+- You have an IBEX server running with a DAE in setup state, which can begin a simulated run
+- You have a readable & writable block named "mot" in the current configuration pointing at 
+the type of block expected by `run_demo_plan`