Skip to content

Commit

Permalink
Update readme to highlight bash commands
Browse files Browse the repository at this point in the history
  • Loading branch information
spirosmaggioros committed Aug 15, 2024
1 parent 7b5cf17 commit 32c594d
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ AlgoPlus is a C++ library that includes ready-to-use complex **data structures**

### **See the full documentation [here](https://csrt-ntua.github.io/AlgoPlus/)**

### **[Join](https://discord.gg/M9nYv4MHz6) our Discord**
### **[Join](https://discord.gg/M9nYv4MHz6) our Discord**

### Example:

Expand Down Expand Up @@ -60,7 +60,7 @@ You can see more [examples](/examples) or follow the [Tutorials](/tutorial).

### Classes

**Graphs**
**Graphs**
- [X] [Di-Graph](https://en.wikipedia.org/wiki/Directed_graph)
- [X] [Graph](https://en.wikipedia.org/wiki/Graph_(discrete_mathematics))

Expand All @@ -70,7 +70,7 @@ You can see more [examples](/examples) or follow the [Tutorials](/tutorial).
- [X] [Binary Search Tree](https://en.wikipedia.org/wiki/Binary_search_tree)
- [X] [Splay Tree](https://en.wikipedia.org/wiki/Splay_tree)
- [X] [Trie](https://en.wikipedia.org/wiki/Trie)
- [X] [Interval Tree](https://en.wikipedia.org/wiki/Interval_tree)
- [X] [Interval Tree](https://en.wikipedia.org/wiki/Interval_tree)
- [X] [234 Tree](https://en.wikipedia.org/wiki/2%E2%80%933%E2%80%934_tree)
- [X] [Min/Max Heap](https://en.wikipedia.org/wiki/Min-max_heap)

Expand All @@ -80,7 +80,7 @@ You can see more [examples](/examples) or follow the [Tutorials](/tutorial).
- [X] [Circular Linked List](https://www.geeksforgeeks.org/circular-linked-list)
- [X] [Skip List](https://en.wikipedia.org/wiki/Skip_list)

**Other**
**Other**
- [X] [Disjoint set](https://en.wikipedia.org/wiki/Disjoint-set_data_structure)
- [X] [Stack](https://en.wikipedia.org/wiki/Stack_(abstract_data_type))
- [X] [Queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type))
Expand All @@ -89,25 +89,25 @@ You can see more [examples](/examples) or follow the [Tutorials](/tutorial).
**Machine Learning(NEW!)**
- [X] [Clustering Algorithms](https://en.wikipedia.org/wiki/Cluster_analysis)
- [X] [Encoders](https://en.wikipedia.org/wiki/Autoencoder)
- [X] [Regression Algorithms](https://en.wikipedia.org/wiki/Regression_analysis)
- [X] [Regression Algorithms](https://en.wikipedia.org/wiki/Regression_analysis)
- [X] [Shortest Path Algorithms](https://en.wikipedia.org/wiki/Shortest_path_problem)
- [X] [Image Processing Algorithms](https://en.wikipedia.org/wiki/Digital_image_processing)


### **How to run test cases**
We have unit tests for every function of our implemented algorithms & data structures. It is very important to make sure that your code works before making any pull requests!
We have unit tests for every function of our implemented algorithms & data structures. It is very important to make sure that your code works before making any pull requests!

**Linux/MacOS**
```
```bash
mkdir build && cd build
cmake ..
make
cd tests
./runUnitTests
```
**Windows**
```
mkdir build
```bash
mkdir build
cmake -S . -B build -G Ninja
cmake --build build
cd build/tests
Expand All @@ -118,23 +118,22 @@ cd build/tests
<a href="https://github.com/CSRT-NTUA/AlgoPlus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=CSRT-NTUA/AlgoPlus" />
</a>
### How to contribute

### **How to contribute**
1. Povide **new implementations** on our already implemented data structures & algorithms.

3. Implement **new classes / algorithms**.


2. Contribute to **unit testing** by writting unit tests for our classes and algorithms.


3. Create and contribute to **APIs for other languages**.

3. Create and contribute to **APIs for other languages**(Check AlgoPy branch).

4. **Promote** the repository on your local workshop/seminar and **get a shout-out**.

See more [here](.github/CONTRIBUTE/CONTRIBUTE.md).

## Star History
For any information or questions, please contact Spiros at **[email protected]**

### **Star History**

[![Star History Chart](https://api.star-history.com/svg?repos=CSRT-NTUA/AlgoPlus&type=Date)](https://star-history.com/#CSRT-NTUA/AlgoPlus&Date)

0 comments on commit 32c594d

Please sign in to comment.