You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,22 +28,22 @@ We are keeping track of our current development plans using [GitHub projects](ht
28
28
29
29
## Updating the documentation
30
30
31
-
The GUI's documentation is hosted on the [Open Ephys Wiki](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/491527/Open+Ephys+GUI). In order to edit the wiki, first you'll need to request an account by emailing info@open-ephys.org. After that, you can make changes to any of the pages by clicking the "edit" button (pencil icon) in the upper right.
31
+
The GUI's documentation is hosted on the [GitHub](https://github.com/open-ephys/gui-docs). If you'd like to edit the documentation, just fork this repository and submit a pull request to the `main` branch. You can also [open an issue](https://github.com/open-ephys/gui-docs/issues) in the documentation repository to recommend a fix.
32
32
33
33
## Building a new plugin
34
34
35
-
The recommended way to add new features to the GUI is by building a new plugin. Instructions on creating plugins can be found [here](https://open-ephys.atlassian.net/wiki/spaces/OEW/pages/46596122/Plugin+build+files). Plugin developers can publish links to their work in [this list](https://open-ephys.atlassian.net/wiki/display/OEW/Third-party+plugin+repositories) to make them available to the general public. Soon, we'll make it possible to share plugins via an installer embedded inside the GUI itself.
35
+
The recommended way to add new features to the GUI is by building a new plugin. Before you start developing a new plugin, you should read through the [Developer Guide](https://open-ephys.github.io/gui-docs/Developer-Guide/index.html) as well as the [plugin development tutorial](https://open-ephys.github.io/gui-docs/Tutorials/How-To-Make-Your-Own-Plugin.html).
36
36
37
-
Before you create a new plugin, you'll need to have some familiarity with C++, as well as makefiles (Linux), Xcode (macOS), or Visual Studio (Windows) for building applications.
37
+
Each year, we select a number of plugins to make available to the community via the GUI's Plugin Installer. If you've built a plugin that you like to release to a wider audience, please get in touch with via info@open-ephys.org!
38
38
39
39
## Updating the main repository
40
40
41
-
If you'd like to make changes to the code found in this repository, please [open an issue](https://github.com/open-ephys/plugin-GUI/issues) that describes what you're working on. Then, edit the code in your [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) of the plugin-GUI repository. Once your changes are ready, please submit a pull request to the `development` branch.
41
+
If you'd like to make changes to the code found in this repository, please [open an issue](https://github.com/open-ephys/plugin-GUI/issues) that describes what you're working on. Then, edit the code in your [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) of the `plugin-GUI` repository. Once your changes are ready, please submit a pull request to the `development` branch, where we stage all changes before each new release.
42
42
43
43
We adhere to the following development cycle:
44
44
* New code is merged into the `development` branch
45
45
* 2-3 weeks prior to a new release, the `development` branch is merged into `testing`, to allow users to test out any features that have been added
46
-
* Once testing is complete, the `testing` branch is merged into `master`, and the pre-compiled binaries are updated
46
+
* Once testing is complete, the `testing` branch is merged into `main`, and the pre-compiled binaries are updated
47
47
48
48
We do not have a predefined release schedule. You can expect releases that include new features to be made every 2-3 months; if there are any critical bug fixes, those will be included in a patch release.
The Open Ephys GUI is designed to provide a fast and flexible interface for acquiring and visualizing data from extracellular electrodes. Compatible data acquisition hardware includes:
6
6
@@ -9,14 +9,14 @@ The Open Ephys GUI is designed to provide a fast and flexible interface for acqu
9
9
-[Intan Recording Controller](http://intantech.com/recording_controller.html) (supports up to 1024 channels)
10
10
-[Neuropixels Probes](http://www.open-ephys.org/neuropixels/) (Windows only, supports up to 6144 channels)
11
11
12
-
The GUI is based around a _true plugin architecture_, meaning the data processing modules are compiled separately from the main application. This greatly simplifies the process of adding functionality, since new modules can be created without the need to re-compile the entire application.
12
+
The GUI is based around a _plugin architecture_, meaning the data processing modules are compiled separately from the main application. This greatly simplifies the process of adding functionality, since new modules can be shared without the need to re-compile the entire application.
13
13
14
14
Our primary user base is scientists performing electrophysiology experiments with tetrodes or silicon probes, but the GUI can also be adapted for use with other types of sensors.
@@ -33,7 +33,7 @@ Our primary user base is scientists performing electrophysiology experiments wit
33
33
34
34
The easiest way to get started is to download the installer for your platform of choice:
35
35
36
-
-[Windows](https://openephysgui.jfrog.io/artifactory/Release-Installer/windows/Install-Open-Ephys-GUI-v0.6.0.exe) (Neuropixels plugins available via File -> Plugin Installer)
@@ -45,7 +45,7 @@ To compile the GUI from source, follow the platform-specific instructions in the
45
45
46
46
## Funding
47
47
48
-
The Open Ephys GUI was created by scientists in order to make their experiments more adaptable, affordable, and enjoyable. Therefore, much of the development has been indirectly funded by the universities and research institutes where these scientists work, especially MIT, Brown University, and the Allen Institute for Brain Science.
48
+
The Open Ephys GUI was created by scientists in order to make their experiments more adaptable, affordable, and enjoyable. Therefore, much of the development has been indirectly funded by the universities and research institutes where these scientists work, especially MIT, Brown University, and the Allen Institute.
49
49
50
50
Since 2014, the support efforts of [Aarón Cuevas López](https://github.com/aacuevas) have been funded by revenue from the [Open Ephys store](https://open-ephys.org/store), via a contract with Universidad Miguel Hernández in Valencia.
0 commit comments