Skip to content

Commit ec63acb

Browse files
author
sarangbishal
committed
Update README.md
1 parent 609930b commit ec63acb

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
![](https://forthebadge.com/images/badges/made-with-python.svg)
44

5+
![PyPI downloads](https://img.shields.io/pypi/dm/recursion-visualiser)
6+
![Stars](https://img.shields.io/github/stars/sarangbishal/Recursion-Tree-Visualizer)
7+
![Forks](https://img.shields.io/github/forks/sarangbishal/Recursion-Tree-Visualizer)
8+
9+
![](https://img.shields.io/pypi/v/recursion-visualiser)
10+
![](https://img.shields.io/pypi/pyversions/recursion-visualiser)
11+
![](https://img.shields.io/github/license/sarangbishal/Recursion-Tree-Visualizer?logo=MIT)
12+
513
Recursion visualiser is a python tool that visualizes recursion tree with animation and draws recursion tree for recursive function.
614
It works with almost any type of recursive function.
715
Just add the recursion-visualiser decorator to your function and let it do the rest of the work.
@@ -23,11 +31,17 @@ The easiest way to install ```recursion-visualiser``` package is from [pypi](ht
2331
```
2432
pip install recursion-visualiser
2533
```
26-
The preferred way to import the class from the package is as:
34+
The preferred way to import the decorator class from the package is as:
2735
```python
2836
from visualiser.visualiser import Visualiser as vs
2937
```
30-
## Example
38+
39+
An alternative way is to clone the repository and install all the requirements.
40+
```
41+
pip install -r requirements.txt
42+
```
43+
44+
## Usage
3145
### 1. Fibonacci
3246
Let's draw the recursion tree for fibonacci number.
3347
Here is how the simple code looks like
@@ -80,9 +94,12 @@ Animation:
8094

8195
![enter image description here](https://raw.githubusercontent.com/sarangbishal/Recursion-Tree-Visualizer/master/examples/fibonacci.png)
8296

83-
Find other examples : [here](https://github.com/sarangbishal/Recursion-Tree-Visualizer/tree/master/examples)
97+
98+
# Support:
99+
Find other examples [here](https://github.com/sarangbishal/Recursion-Tree-Visualizer/tree/master/examples)
84100
and read more about **recursion-visualiser** [here](https://github.com/sarangbishal/Recursion-Tree-Visualizer/blob/master/Examples.md)
85-
101+
The official documentation for recursion-visualiser is available at [https://recursion-visualiser.readthedocs.io/en/](https://recursion-visualiser.readthedocs.io/en/latest/) ![](https://img.shields.io/badge/under-progress-green)
102+
86103
## TODO:
87104
- [x] Minimal working version
88105
- [x] Upload package to pypi

0 commit comments

Comments
 (0)