feature/codebase-visualization (#34)

.github/workflows/codebase_diagram.yml

@@ -0,0 +1,17 @@
+name: Create codebase diagram
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - master
+jobs:
+  get_data:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+      - name: Update diagram
+        uses: githubocto/repo-visualizer@main
+        with:
+          excluded_paths: "ignore,.github"
+          output_file: "Images/diagram.svg"

README.md

@@ -23,7 +23,7 @@ Related algorithms that are implemented in this repository are:
 For more details about the algorithm, experiments as well as the importance of homogeneously distributed keypoints for SLAM please refer to the [paper](https://www.researchgate.net/publication/323388062_Efficient_adaptive_non-maximal_suppression_algorithms_for_homogeneous_spatial_keypoint_distribution).
 
 ## How to run
-1. Clone this repository: ``` git clone https://github.com/BAILOOL/ANMS-Codes.git ```
+1. Clone this repository: `git clone https://github.com/BAILOOL/ANMS-Codes.git`. See [codebase visualization](https://octo-repo-visualization.vercel.app/?repo=BAILOOL%2FANMS-Codes) to better understand code repository structure.
 2. Choose your language:
     - [C++](https://github.com/BAILOOL/ANMS-Codes/tree/master/C++)
     - [Python](https://github.com/BAILOOL/ANMS-Codes/tree/master/Python)