updated README

This commit is contained in:
Sébastien Quistrebert 2024-03-25 14:14:50 +01:00
parent d6640e2414
commit 347fe0a6ef

View file

@ -1,6 +1,8 @@
pymodaq_plugins_template
pymodaq_plugins_lightfield
########################
TO BE UPDATED, NOT PUBLISHED ON PYPI YET
.. the following must be adapted to your developed package, links to pypi, github description...
.. image:: https://img.shields.io/pypi/v/pymodaq_plugins_template.svg
@ -25,52 +27,22 @@ Use this template to create a repository on your account and start the developme
Authors
=======
* First Author (myemail@xxx.org)
* Other author (myotheremail@xxx.org)
.. if needed use this field
* Sébastien Quistrebert (sebastien.quistrebert@ens-paris-saclay.fr)
Contributors
============
* First Contributor
* Other Contributors
.. if needed use this field
Depending on the plugin type, delete/complete the fields below
*
Instruments
===========
Below is the list of instruments included in this plugin
Actuators
+++++++++
* **yyy**: control of yyy actuators
* **xxx**: control of xxx actuators
Viewer0D
++++++++
* **yyy**: control of yyy 0D detector
* **xxx**: control of xxx 0D detector
Viewer1D
++++++++
* **yyy**: control of yyy 1D detector
* **xxx**: control of xxx 1D detector
Viewer2D
++++++++
* **yyy**: control of yyy 2D detector
* **xxx**: control of xxx 2D detector
* **lightfield**: control of lightfield 1D detector
PID Models
==========
@ -83,6 +55,6 @@ Extensions
Installation instructions
=========================
* PyMoDAQs version.
* Operating systems version.
* What manufacturers drivers should be installed to make this plugin run?
* PyMoDAQs version >= 4.1.0.
* Operating systems version: tested on windows 11.
* What manufacturers drivers should be installed to make this plugin run? TODO