From dd6b9e2e9c99ecc54514fb4c4ce803173cbc1294 Mon Sep 17 00:00:00 2001 From: "Lemmer, Jan" <jan.lemmer@fst.tu-darmstadt.de> Date: Thu, 7 Oct 2021 15:24:45 +0200 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 448a251..973c29a 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,25 @@ `PlotID` is a toolkit that labels your plots and figures and copies all associated data (research data, plotting script, user-functions and a copy of the figure) to the desired location. This version of `PlotID` is build for `MATLAB`. -`PlotID` provides two core functions TagPlot and Publish which are described in Detail below. +`PlotID` provides two core functions TagPlot and Publish which are described in detail below. Feel free to give feedback and feature requests or to take part in the development process. [TOC] # Quick User Guide +PlotID works in two Steps: + +1. tagging the plot +`[figs, IDs] = plotId.TagPlot(figs, options)` + + +2. publishing the plot and the associated data +`plotID.Publish(DataPaths, ID, figure, options)` + +`DataPaths.script = mfilename('fullpath');` contains the filename of the m.script + +`DataPaths.rdata = {dataset1, dataset2};` file names of the datasets (they most be at the path) # PlotID.TagPlot() `[figs, IDs] = TagPlot(figs, options)` -- GitLab