diff --git a/README.md b/README.md index a5281b4..9cb0934 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # algorithms -Solved (and usually heavily documented) online judge and classic CS problems as well as -various data structure implementations - almost exclusively in C++. +This repository contains solutions and implementations to various data structures and +algorithms specifically in C++. Judged problems along with other classic CS problems +are also contained within this repository. + +## Contents +### 1. Data Structures + +Binary Search Tree, Linked List, Min Heap, Queue, Queue from stacks, Stack, Vector + +### 2. Algorithms + +Array Algorithms, Bit Manipulation, Combinatorics, Data Structure Algorithms, Dynamic Programming +Geometry, Number Algorithms, Searching and Sorting, String Algorithms. For more information +Go into **file** (**Here.** [`algorithms`](./src/algorithm_practice)) + +## Purpose The purpose of this repository is to act as a curation of @@ -17,3 +31,22 @@ the understanding of techniques and concepts is easily transferred. Inside the ` see the folders `algorithm_practice` and `datastructures`. The contents of these folder is pretty obvious, but each one has its own accompanying documentation to further explain the file structure and organization involved. + +## Usage + +Each algorithm and data structure is contained in its own C++ .h file for datastructures +and .cpp file for algorithms. Maintain this format along with providing a readme when +adding a new data structure or algorithm. + +## Contributing + +Feel free to fork the repository and add your own data structures and algorithms. +Adding these new features and creating pull requests are welcomed! + +## Contributors + +[](https://github.com/domfarolino/algorithms/graphs/contributors) + +## License + +[MIT](./LICENSE)