Skip to content

Commit 01d33d3

Browse files
Add instructions to get help.
1 parent 9343745 commit 01d33d3

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The `MicroscopeClient` object has a few basic methods. If you created an instan
8888
|`microscope.record_video(format, framerate, length, save_locally, save_location)`| `format`: video format (`h264` and `mjpeg` tested) (default: h264)<br/>`framerate`: video framerate (fps) (default: 30)<br/>`length`: length of video (seconds) (default: 1)<br/>`save_locally`: Logical on whether to save video locally (default: true) <br/>`save_location`: The directory in which to save the video (filename is the timestamped one generated by the microscope) (default: current working directory) | The location (either locally or on the microscope) where the video has been saved| Records a video using the [video extension](https://gitlab.com/openflexure/microscope-extensions/openflexure-videoplugin).|
8989
|`microscope.preview()` | | |Launches a preview window displaying a live video feed from the microscope.|
9090

91-
91+
For more information, run `help OFMClient`.
9292
## Extensions
9393

9494
To run methods provided by the microscope extensions, you can use the `extensions` `struct` to make `get` or `post` requests.

0 commit comments

Comments
 (0)