Chapter 16 Developer Guidelines

16.1 Documentation

There are three main kinds of documentation in the WildlifeSystems project.

1. Code comments: Primarily for future you (or someone similar) to get to grips with your code. Why does this code do this?.

2. Package documentation: Describes what your package does, how it interacts with the larger system. What will this package do for me?

3. Overall project documentation: This manual. How do I use the entire system for my research?

16.2 File system layout

|- /etc/ws              # Configuration files (editable by end user)
|- /usr/bin             # Main scripts        (do not edit)
|- /var/ws              # Data storage        (do not edit)
   |- audio             # Audio data
   |- bluetooth         # Bluetooth data