docs: add docs folder for assets and misc files

Author: 4ndrelim

.idea/workspace.xml

@@ -1,9 +1,11 @@
-# data-structures-and-algorithms
+# Data Structures & Algorithms
 This repository contains implementation of some fundamental data structures and algorithms in Computer Science. It is primarily used as a teaching resource and is currently being developed by ex-2040s students.
 
-**Also**, the structure of the codebase is optimised for IntelliJ IDEA since implementation are mostly written in Java.
+The project uses Gradle and the structure is optimised for IntelliJ IDEA since implementation are mostly written in Java.
 
-**Note**: This is still being developed! Those below with links mean that they are complete (alongside testing). We project to complete CS2040s course content by November and along the way, add interesting algorithms/problems. If you wish to contribute, do drop me an email at [email protected].
+**Note**: This is still being developed. Those below with links mean that they are complete (alongside testing). We project to complete CS2040s course content by November and along the way, add interesting algorithms/problems. We are hopeful that the subsequent batches of students (from AY23/24 S2) will benefit greatly from this. 
+
+If you wish to contribute, do drop an email at [email protected].
 
 ## Full List of Implementation (in alphabetical order):
 ## Structures
@@ -12,57 +14,56 @@ This repository contains implementation of some fundamental data structures and
     * Quick Find
     * Weighted Union 
     * Path compression
-- [Hashing](src/dataStructures/hashSet)
-    * [Chaining](src/dataStructures/hashSet/chaining/)
-    * [Open Addressing](src/dataStructures/hashSet/openAddressing/)
-- [Heap](src/dataStructures/heap/)
+- [Hashing](src/main/java/dataStructures/hashSet)
+    * [Chaining](src/main/java/dataStructures/hashSet/chaining)
+    * [Open Addressing](src/main/java/dataStructures/hashSet/openAddressing)
+- [Heap](src/main/java/dataStructures/heap)
     * Max heap implementation
-- [Linked List](src/dataStructures/linkedList)
+- [Linked List](src/main/java/dataStructures/linkedList)
 - LRU Cache
 - Minimum Spanning Tree
-- [Queue](src/dataStructures/queue)
+- [Queue](src/main/java/dataStructures/queue)
 - Segment Tree
     * Array implementation
     * TreeNode implementation 
-- [Stack](src/dataStructures/stack)
+- [Stack](src/main/java/dataStructures/stack)
 - Trie
 
 
 ## Algorithms
-- [Counting Sort](src/algorithms/sorting/countingSort/)
-- [Cyclic Sort](src/algorithms/sorting/cyclicSort/)
-    * [Special case](src/algorithms/sorting/cyclicSort/simple) of O(n) time complexity
-    * [Generalized case](src/algorithms/sorting/cyclicSort/generalised) of O(n^2) time complexity
-- [Knuth-Morris-Pratt](src/algorithms/patternFinding/) aka KMP algorithm
-- [Matrix Operations](others/matrix_operations/)
-- [Bubble Sort](src/algorithms/sorting/bubbleSort)
-- [Insertion Sort](src/algorithms/sorting/insertionSort)
-- [Selection Sort](src/algorithms/sorting/selectionSort)
+- [Counting Sort](src/main/java/algorithms/sorting/countingSort)
+- [Cyclic Sort](src/main/java/algorithms/sorting/cyclicSort)
+    * [Special case](src/main/java/algorithms/sorting/cyclicSort/simple) of O(n) time complexity
+    * [Generalized case](src/main/java/algorithms/sorting/cyclicSort/generalised) of O(n^2) time complexity
+- [Knuth-Morris-Pratt](src/main/java/algorithms/patternFinding) aka KMP algorithm
+- [Bubble Sort](src/main/java/algorithms/sorting/bubbleSort)
+- [Insertion Sort](src/main/java/algorithms/sorting/insertionSort)
+- [Selection Sort](src/main/java/algorithms/sorting/selectionSort)
 - Merge Sort
-    * [Recursive](src/algorithms/sorting/mergeSort/recursive)
-    * [Bottom-up iterative](src/algorithms/sorting/mergeSort/iterative)
+    * [Recursive](src/main/java/algorithms/sorting/mergeSort/recursive)
+    * [Bottom-up iterative](src/main/java/algorithms/sorting/mergeSort/iterative)
 - Quick Sort
-    * [Hoare's](src/algorithms/sorting/quickSort/hoares)
-    * [Lomuto's](src/algorithms/sorting/quickSort/lomuto)
-    * [Paranoid](src/algorithms/sorting/quickSort/paranoid)
-    * [3-way Partitioning](src/algorithms/sorting/quickSort/threeWayPartitioning)
+    * [Hoare's](src/main/java/algorithms/sorting/quickSort/hoares)
+    * [Lomuto's](src/main/java/algorithms/sorting/quickSort/lomuto)
+    * [Paranoid](src/main/java/algorithms/sorting/quickSort/paranoid)
+    * [3-way Partitioning](src/main/java/algorithms/sorting/quickSort/threeWayPartitioning)
 - Radix Sort
 
 
 ## Short-cut to CS2040S Material
 1. Basic structures
-    * [Linked List](src/dataStructures/linkedList)
-    * [Stack](src/dataStructures/stack)
-    * [Queue](src/dataStructures/queue)
+    * [Linked List](src/main/java/dataStructures/linkedList)
+    * [Stack](src/main/java/dataStructures/stack)
+    * [Queue](src/main/java/dataStructures/queue)
 2. Binary Search
     * Peak Finding
     * Template
 3. Sorting
-    * [Bubble](src/algorithms/sorting/bubbleSort)
-    * [Insertion](src/algorithms/sorting/insertionSort)
-    * [Selection](src/algorithms/sorting/selectionSort)
-    * [Merge](src/algorithms/sorting/mergeSort)
-    * [Quick](src/algorithms/sorting/quickSort)
+    * [Bubble](src/main/java/algorithms/sorting/bubbleSort)
+    * [Insertion](src/main/java/algorithms/sorting/insertionSort)
+    * [Selection](src/main/java/algorithms/sorting/selectionSort)
+    * [Merge](src/main/java/algorithms/sorting/mergeSort)
+    * [Quick](src/main/java/algorithms/sorting/quickSort)
 4. Trees
     * Binary search tree
     * AVL-tree
@@ -71,15 +72,15 @@ This repository contains implementation of some fundamental data structures and
     * Augmented tree for orthogonal range searching
     * Red-Black Tree
     * ab-Tree
-5. [Binary Heap](src/dataStructures/heap/)
+5. [Binary Heap](src/main/java/dataStructures/heap)
     * Max heap implementation
 6. Disjoint Set / Union Find
     * Quick Find
     * Weighted Union
     * Path compression
-7. [Hashing](src/dataStructures/hashSet)
-    * [Chaining](src/dataStructures/hashSet/chaining/)
-    * [Open Addressing](src/dataStructures/hashSet/openAddressing/)
+7. [Hashing](src/main/java/dataStructures/hashSet)
+    * [Chaining](src/main/java/dataStructures/hashSet/chaining)
+    * [Open Addressing](src/main/java/dataStructures/hashSet/openAddressing)
     * Double Hashing
     * Bloom filter
 8. Basic graphs
@@ -94,13 +95,8 @@ This repository contains implementation of some fundamental data structures and
     * Kruskal's
 
 
-# Contributors
-Andre 
-
-Kai Ting
-
-Owen 
-
-Chang Xian
+## Running Custom Inputs
+See [here](scripts/)
 
-Yeo Shu Heng
+## Contributors
+See the [team]()!