From 9fb417e4e6fc446ccdcea36b65363cbb2188819e Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Fri, 21 Feb 2025 10:40:25 +0000 Subject: [PATCH] Edit v3 branch readme as we make it the Default branch to point people to master if they are looking for v2 code --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index b64dbc86..766c4690 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # OpenFlexure Microscope Software +> ## This is the v3 development branch +> We are no longer actively developing v2, but v3 is not yet released. +> v3 is not yet stable enough for wider public release. Deveopment snapshots are released from time to time. +> If you want to use a development snapshot before we do a wider alpha release the best thing to do is get in contact on the [forum](https://openflexure.discourse.group/). + If you want to look at the code for v2 you should look at the [master branch](https://gitlab.com/openflexure/openflexure-microscope-server/-/tree/master). + + The "server" is the main component of the OpenFlexure Microscope's software. It is responsible for controlling microscope hardware, data management, and allowing it to be controlled locally and over a network. This repository includes the graphical interface, which is implemented as a web application served from the root of the Python web server. The simplest way to use it is via OpenFlexure eV, which should find your microscope on the network, and display the interface. The microscope's interface can also be accessed at `http://microscope.local:5000/` in a web browser, assuming the hostname of your microscope is `microscope`.