Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.33 KB

README.md

File metadata and controls

48 lines (33 loc) · 2.33 KB

Bioimage Analysis Training Resource

Gitpod ready-to-code

Module overview

Home page

This project is intended to collect together various resources that can be useful when planning/delivering training in image analysis.

About

Teach

The material in this repository can be flexibly used in many ways.

Some guidance and tips can be found in TEACHING_TIPS

Contribute

Detailed guidance for contributing can be found in CONTRIBUTING.md.

Repository

Current repository structure:

  • template things:
    • _includes/: among other things, contains folders holding activities and exercises specific to different platforms for image analysis, for each module
    • _layouts/, _sass/, Gemfile, _config.yml, Makefile, assets, .gitignore: material for building the webpages associated with this repository
  • content things:
    • _modules/: all of the individual module pages are collected here
    • _extras/: additional pages to complement the modules
    • figures/: a collection of illustrations/diagrams used to help explain the concepts in each module.
    • image_data/: image files used in activities and exercises
    • module_templates/: template file(s) as an example for module pages
    • src/: code for image analysis
    • workshops/: information on workshops taught using this material
    • example_images.md: intended to contain links to images that would make good examples when teaching
    • index.md: content for the website landing page
  • other pages (from Carpentries lesson template):
    • aio.md: an 'all-in-one' version of the material, combining all the modules into a single page
    • reference.md: currently blank but could be populated with a glossary/other reference material
    • setup.md: a page for setup instructions - currently blank but could be populated with instructions for relevant technical setup/installation