Robot Racing 2019/20 Software - Hummingbot
This repository contains the current competition code (2019), which will be used used for IARRC 2019. A list of what we’re currently working on is in the issues section of this repo.
Here is a good doc that outlines everything you need to know in order to get set up and working with the codebase!
Please review the competition rules before pushing any code :)
For C++ code and Python Scripts we follow the Google coding standards linked below
Git workflow that we follow
Please fill out this header above all functions (Doxygen style)
/** @brief Writes the current position of the cursor* into the arguments row and col.* @param row The address to which the current cursor* row will be written.* @param col The address to which the current cursor* column will be written.* @return Void.*/void GetCursor(int* row, int* col);
Please fill this header out above every source code file(including launch files and xml files)
/** @file console.h* @brief Function prototypes for the console driver.** This contains the prototypes for the console* driver and eventually any macros, constants,* or global variables you will need.** @author YOUR NAME (GITHUB_USERNAME)* @author Toni Ogunmade(oluwatoni)* @competition IARRC 2018*/
In order to generate documentation, go to the base directory of this repo and run:
doxygen doxygen_config
It is setup to document all *.c, *.cpp, *.h, and *.hpp files. It will generate html output under doxygen_output/html. To view this, reference the index.html file in that directory in a browser of your choice. Feel free to change the doxygen_config file in order to generate different types of documentation or cover more file types.