rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review of branch pull-webapp

Browse source 
Co-authored-by: Joe Knapper <joe.knapper@glasgow.ac.uk>
This commit is contained in:
Julian Stirling 2025-08-06 15:27:02 +00:00
parent 7a241f30a1
commit ac98205391
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -48,7 +48,7 @@ To set up a development environment you will need Python 3.11 and the static fil
### Installation and set up on a Raspberry Pi ### Installation and set up on a Raspberry Pi
Python 3.11 should come with the OpenFlexure Raspberry Pi OS image. We do not recommend trying to develop on a standard OS image. The OpenFlexure Raspberry Pi OS image comes with Python 3.11 already installed. We do not recommend trying to develop on the standard Raspberry Pi OS image.
* To activate the microscope virtual environment run `ofm activate` * To activate the microscope virtual environment run `ofm activate`
@ -94,8 +94,8 @@ To start the simulation server:
Please first read our **[project contributions guide](./CONTRIBUTING.md)** Please first read our **[project contributions guide](./CONTRIBUTING.md)**
* We recommend all development is done on a branch. * We recommend all development is done on a branch.
* If you are editing the web app please see our see the README in the [webapp](./webapp) directory. * If you are editing the web app, please see our see the README in the [webapp](./webapp) directory.
* If you want to try a branch that with webapp changes and don't want to compile the javascript run `python pull_webapp.py -b <branch_name>` to get the artifacts from the GitLab CI. * If you want to try a branch with webapp changes (that are already pushed to GitLab), but don't want to compile the javascript, then run `python pull_webapp.py -b <branch_name>` to get the artifacts from the GitLab CI.
**For development on a Raspberry Pi** we recommend VSCode Remote session from another computer. This allows you to use your usual developer environment to write code, but everything runs on the Raspberry Pi with real hardware. Note that the repository is cloned by default over `https`, so you will probably need to change the "remote" URL to your fork of the repository, or to SSH, before you're able to push changes. **For development on a Raspberry Pi** we recommend VSCode Remote session from another computer. This allows you to use your usual developer environment to write code, but everything runs on the Raspberry Pi with real hardware. Note that the repository is cloned by default over `https`, so you will probably need to change the "remote" URL to your fork of the repository, or to SSH, before you're able to push changes.