commented doxygen-mainpage, added files-list link

This commit is contained in:
Krishna Vedala
2020-05-28 23:22:24 -04:00
committed by GitHub
parent 29bdf4438b
commit 68392e2aa8

View File

@@ -1,4 +1,7 @@
# The Algorithms - C++ # {#mainpage}
<!--# DO NOT REMOVE THIS LINE
This is for Doxygen to recognize as the index file for the complete documentation
{#mainpage} -->
# The Algorithms - C++
[![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](https://github.com/kvedala/C-Plus-Plus/blob/master/CONTRIBUTION.md)&nbsp;
![GitHub repo size](https://img.shields.io/github/repo-size/kvedala/C-Plus-Plus?color=red&style=flat-square)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/kvedala/C-Plus-Plus?color=green&style=flat-square)
@@ -6,9 +9,11 @@
![cpplint](https://github.com/kvedala/C-Plus-Plus/workflows/cpplint_modified_files/badge.svg)
![C/C++ CI](https://github.com/kvedala/C-Plus-Plus/workflows/C/C++%20CI/badge.svg)
[Documentation](https://kvedala.github.io/C-Plus-Plus)
[Online Documentation](https://kvedala.github.io/C-Plus-Plus).
### All algorithms implemented in C++ (for education)
Click on [Files menu](https://kvedala.github.io/C-Plus-Plus/build/html/files.html) to see the list of all the files documented with the code.
### Algorithms implemented in C++ (for education)
The implementations are for learning purpose. They may be less efficient than the implementation in the standard library.
### Contribute Guidelines