Document the internals of the sensor fusion code that are useful to modify

BjarneBitscrambler / OrientationSensorFusion-ESP

Files for performing orientation sensor fusion using NXP version 7 algorithm, ported to Espressif platforms.

BSD 3-Clause "New" or "Revised" License

23 stars 12 forks source link

Document the internals of the sensor fusion code that are useful to modify #4

Closed BjarneBitscrambler closed 3 years ago

BjarneBitscrambler commented 3 years ago

The sensor fusion code consists of a large number of source files. It isn't obvious which ones to modify for a given purpose, so documenting the structure of the fusion code and how it relates to particular files would be useful.

The comments in each source file are reasonably clear, but it's tedious to open up each file to have a look. Document the overall structure perhaps in the WiKi, or a Readme.txt file

BjarneBitscrambler commented 3 years ago

Renamed and changed the structure of a few files for clarity and consistency.

BjarneBitscrambler commented 3 years ago

Completed first round of code cleanup in Issue #8. See source code subfolder /docs for documentation on file structure.