Skip to content

Commit

Permalink
ENH - added installation instructions to README, see openjournals/jos…
Browse files Browse the repository at this point in the history
  • Loading branch information
robertoostenveld authored and schoffelen committed Jun 28, 2024
1 parent fe4a344 commit ba5cb8d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,24 @@ easily allows methods researchers to incorporate new methods for EEG/MEG analysi

For more information, documentation, and tutorials, please visit http://www.fieldtriptoolbox.org

## Installation

To install the FieldTrip toolbox on your computer, you can clone this repository or
download the zip file, unzip it, and add it to your MATLAB path. Subsequently you call
the `ft_defaults` function, which will add the required subdirectories to the path.

We recommend that you add the `addpath(...)` and the `ft_defaults` command to your
[startup.m](https://www.mathworks.com/help/matlab/ref/startup.html) file. See
also https://www.fieldtriptoolbox.org/faq/installation/

Note that you should not use `addpath(genpath(...))` and we recommend not to use the
"add with subdirectories" button in the graphical path setup tool, as there are a
number of external toolboxes and backward compatibility directories that you should
not add to your path. If those directories are needed, then `ft_defaults` and
`ft_hastoolbox` will take care of them.

## Copyright

The FieldTrip software is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
Expand Down

0 comments on commit ba5cb8d

Please sign in to comment.