Wenzel-Lab Repository Template

The Wenzel-Lab template for building Python-based laboratory instrument software and open hardware documentation repositories.

This repository serves as:

• Template - Copy this structure when starting new projects
• Reference - Find guides and conventions used in Wenzel-Lab
• Standard - Ensure consistency across all Wenzel-Lab repositories

For more resources on open-source hardware for bioimaging, see LIBRE Hub and the Wenzel Lab website.

---

Quick Start

For New Projects

1. Use this as a template:

   # On GitHub: Click "Use this template" button
   # Or locally:
   git clone https://github.com/wenzel-lab/repository-template.git your-project-name
   cd your-project-name
   rm -rf .git
   git init

2. Follow the guides:

   • Software projects: Guide to software design for instrument control
   • Hardware projects: Hardware README guide
   • New to software? Start with QUICK_START.md

3. Customize:

   • Replace placeholder text
   • Add project-specific files
   • Remove unused sections

---

Contents

Software Development

• Guide to software design for instrument control - Complete guide for building Python-based instrument control software
• QUICK_START.md - Beginner-friendly getting started guide
• example-structure/ - Example file structure

Hardware Documentation

• HARDWARE_README_TEMPLATE.md - Full-featured template
• HARDWARE_README_TEMPLATE_MINIMAL.md - Simplified template
• hardware-readme-guide.md - How to use the templates

Conventions

• NAMING_CONVENTIONS.md - Naming guidelines
• LICENSING_GUIDE.md - License selection and usage

---

Contributing

Found an issue or have a suggestion for this template?

1. Open an issue describing the problem or suggestion
2. Submit a pull request with improvements
3. Share examples from your projects

Contacts:

• Wenzel-Lab GitHub: https://github.com/wenzel-lab
• Wenzel-Lab Website: https://wenzel-lab.github.io/en/
• LIBRE Hub: https://github.com/LIBREhub

---

License

This project is Open Source - please acknowledge us when using this template or sharing modifications externally.