From 1284d4ce994bd653d3298dbca484e9c33cf60447 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20M=2E=20Requena=20Plens?= Date: Fri, 17 Mar 2023 17:16:10 +0100 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b14d703..ee94187 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # picoScopeMATLAB -Library for working with the PicoScope 5000 series (and possibly other models) in MATLAB +Library for working with the PicoScope 5000 series (and possibly other models) in MATLAB. + +This repository includes the necessary toolboxes developed by Pico Technology: + +- PicoScope 5000 Series A API MATLAB Generic Instrument Driver. +- PicoScope Support Toolbox. + +It is only necessary to install the **PicoSDK** to make it fully functional. It can be downloaded here: https://www.picotech.com/downloads + +At the moment it is only compatible with Linux and Windows. I have not been able to get it to work completely on MacOS. If you have information or have managed to get it to work correctly on MacOS, please contact me. + +## Help + +To see the help you can run one of these lines in matlab: +```matlab +addpath(genpath('picoscope5000')) +help picoscope5000 +``` +```matlab +addpath(genpath('picoscope5000')) +doc picoscope5000 +``` +| Using `doc` | Using `help` | +|:------------------------------------------------:|:-------------------------------------------------:| +| | | + +## Examples + +Open the **Examples.m** file, where you will find some examples. +You can see the code in the **picoscope5000** folder or by executing `open` + the name of the example.