Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add additional contributing documentation on how the directory structure is laid out #45

Open
adam2392 opened this issue Jun 9, 2021 · 0 comments

Comments

@adam2392
Copy link
Member

adam2392 commented Jun 9, 2021

The general directory structure is:

  • docs/ or doc/ hosting documentation that gets rendered into a webpage, which then you can see online
  • mne-hfo/ is the directory with all the actual code
  • .circleci/ hosts testing code setup to run things on CircleCI (a cloud service company for testing code continuously)
  • .github/ hosts Github related code like templates for GH issues and also testing code setup for GH's cloud service for testing code
  • tests/ is the directory with all the unit and integration tests that test various pieces of the mne-hfo code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant