From 68392e2aa866f6bb0ac5d1b84f4e37ca3beaaed2 Mon Sep 17 00:00:00 2001 From: Krishna Vedala <7001608+kvedala@users.noreply.github.com> Date: Thu, 28 May 2020 23:22:24 -0400 Subject: [PATCH] commented doxygen-mainpage, added files-list link --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b56c4f5f4..9fb649a0e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# The Algorithms - C++ # {#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)  ![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