Akimot reference manual

Introduction

Welcome to Akimot's reference manual. The purpose of this manual is to provide a helper for akimot developers. If you are completely new to the project, we suggest to start with files list and basic overview given below.

This manual might be useful in particular cases to quickly understands relations among classes or to get short descriptions of methods/variables. It is not meant as an exhaustive documentation though. We believe the best way to gain the sound understanding of certain project parts is following: gain basic information about the target from this manual and then dive into the code - we have strived for legibility of code and documented the more complicated parts.

We hope you will find this reference manual useful and that it will help you with your work on the akimot project.

Basic overview

This overview is intended to introduce main modules and some of their core functionality. Commented code snippets are combined with links to other relevant manual sections.