From b82e2e6e78bd122a860ab74dd847c4aed659f736 Mon Sep 17 00:00:00 2001 From: wendtalexander Date: Sun, 19 Oct 2025 10:08:25 +0200 Subject: [PATCH] [doc] adding simple usage --- doc/usage.qmd | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/usage.qmd b/doc/usage.qmd index e53a0d1..60586e2 100644 --- a/doc/usage.qmd +++ b/doc/usage.qmd @@ -1,3 +1,11 @@ --- title: How to use it --- + +If you have a folder or multiple folders with each containing two recordings one from `relacs` and one from `open-ephys` you can simply run the CLI like this: + +```{python} +# leave out the ! at the beginning if you running this in your shell +!oephys2nix ../oephys2nix/test/Test1/ +``` +which provides you with information about the transition of the stimuli into the new file.