From 4d1f8ccea2da52e7c614a101bdca8aea540cd086 Mon Sep 17 00:00:00 2001 From: Arunava Date: Mon, 13 Dec 2021 15:51:41 -0500 Subject: [PATCH] [3.27] Update readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 08fa861..3c693a5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ + # Autonomous Lawn Mower - ALM [![Build Status](https://app.travis-ci.com/llDev-Rootll/Autonomous_Lawn_Mower.svg?branch=master)](https://app.travis-ci.com/llDev-Rootll/Autonomous_Lawn_Mower) @@ -132,6 +133,15 @@ Run the following command in the root directory to generate cpplint results in * Run the following command in the root directory to generate cppcheck results in **results** folder sh run_cppcheck.sh + ## Doxygen Documentation + + +To generate the doxygen documents: +``` +doxygen doxy_config +``` + +The documents are generated in `./docs` folder. ## Phase 1 - Final Proposal has been updated with the suggestion made from the last phase - The github repo, travi-ci, and coveralls has been linked. @@ -159,4 +169,4 @@ Please refer to the backlog table, [here](https://docs.google.com/spreadsheets/d - Designed the unit test structure of each class and developed unit testing for functionalities. - UMLs were revised according to the appropriate changes made. -Please refer to the backlog table, [here](https://docs.google.com/spreadsheets/d/1cmejfr571rCQcNI3y2g41rq-KDfKz_WwcTCoZqvluJA/edit#gid=1285958998), for an exhaustive list of tasks completed in Phase 3. +Please refer to the backlog table, [here](https://docs.google.com/spreadsheets/d/1cmejfr571rCQcNI3y2g41rq-KDfKz_WwcTCoZqvluJA/edit#gid=1285958998), for an exhaustive list of tasks completed in Phase 3. \ No newline at end of file