Skip to content

Commit 390e197

Browse files
committed
Updated index.rst
1 parent 57d3474 commit 390e197

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

docs/index.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22
Pygorithm
33
=========
44

5-
A fun way to learn algorithms on the Go!
6-
7-
Just import the module and start learning, it's that easy.
5+
| ``Pygorithm``: A fun way to learn algorithms on the go!
6+
| Just import the module and start learning, it's that easy.
87
8+
A Python module written in pure python and for purely educational purposes.
9+
Get the code, time complexities and much more by just importing the required algorithm.
910

1011
Table of Contents:
1112
------------------
1213

1314
.. toctree::
14-
:maxdepth: 2
1515

1616
Sorting
17+
Searching
1718

1819

1920
-----------------
@@ -37,3 +38,16 @@ Quick Start Guide
3738
---------------
3839
Getting Started
3940
---------------
41+
42+
* For getting started, first download the package using Python package manager
43+
44+
::
45+
46+
pip3 install pygorithm
47+
48+
* For Python 2, you can use pip instead. Depending on your user permissions, you might need to ``sudo`` before installing
49+
50+
51+
* :ref:`genindex`
52+
* :ref:`modindex`
53+
* :ref:`search`

0 commit comments

Comments
 (0)