Repository structure

Here's an overview of the current repository structure:

Home folder

• README.rst - reStructuredText file with a brief introduction to the GUI, along with installation instructions
• license.txt - GPL v3.0 license file
• .gitignore - lists the files and folders Git shouldn't track; for example, binaries in the build/ folder that shouldn't be uploaded to the repository
• open-ephys.jucer - the file loaded into the "Jucer" that defines how the GUI should be compiled. IMPORTANT: Makefiles are auto-generated by the Jucer, so if you want to add files, delete files, or change the compiler flags, you must do it through the Jucer, available in the JuceLibraryCode/jucer/ folder.

[Source]((https://github.com/open-ephys/GUI/tree/master/Source) folder

• Main and MainWindow files
• Processors folder
  • All of the individual data processing modules
  • DataThreads folder - source code for threads that interface with external inputs
  • Editors folder - source code for processor editors
  • Utilities folder - source code for splitters and mergers
  • Visualization folder - the source code for visualizers, such as the LfpDisplayCanvas
• UI folder - source code for user-interface classes
• Network folder - network-related code
• Dsp folder - code from the Digital signal processing library
• Audio folder - code for interfacing with the system audio

JuceLibraryCode folder

• Header files included by almost all of the GUI source code
• src folder - contains the entire Juce source code, with some important modifications
• amalgamated folder - needed for compiling the Juce library
• jucer folder - contains source code and makefiles for the Jucer, which must be used to add or subtract folders from the GUI build

Resources folder

• Images used by the application
• Fonts used by the application

Any new resources must be added to the these folders AND referenced within the Jucer application. For fonts used by FTGL in OpenGLComponents, you can add the original TTF or OTF files. For fonts used by Juce components, you need to serialize the fonts using the Font Serializer application found here. It seems like there's a bug in loading TTF files directly into Juce, at least on Linux.

Builds folder

• holds the Linux Makefile and OS X Xcode project
• Check out the Linux, OS X, and Windows wiki pages for issues with compiling the GUI on different platforms.

---

<< Back to key classes | Continue to How to contribute >>