Skip to content

Commit 0e748b9

Browse files
committed
Updated README
1 parent 8905d3c commit 0e748b9

File tree

1 file changed

+57
-2
lines changed

1 file changed

+57
-2
lines changed

README.rst

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
1-
# pygorithms
2-
A Python module with all major algorithms
1+
==========
2+
Pygorithms
3+
==========
4+
5+
| A Python module to learn all the major algorithms on the go!
6+
| Purely for educational purposes
7+
8+
Features
9+
~~~~~~~~
10+
11+
* Super easy to use
12+
* A very easy to understand `Documentation <http://pygorithm.readthedocs.io/en/latest/>`_
13+
* Get the code right in your editor
14+
* Get time complexities on the go
15+
16+
Installation
17+
~~~~~~~~~~~~
18+
19+
* Just fire the following command in your terminal:
20+
21+
::
22+
23+
$pip3 install pygorithm
24+
25+
- | It's that easy. If you are using Python 2.7 use pip instead. Depending on your
26+
| permissions, you might need to ``sudo`` before installing
27+
28+
29+
Quick Start Guide
30+
~~~~~~~~~~~~~~~~~
31+
32+
* To sort your list
33+
34+
.. code:: python
35+
36+
from pygorithm.sorting import bubble_sort
37+
myList = [12, 4, 3, 5, 13, 1, 17, 19, 15]
38+
sortedList = bubble_sort.sort(myList)
39+
print(sortedList)
40+
41+
42+
* To get the code for function used
43+
44+
.. code:: python
45+
46+
from pygorithm.sorting import bubble_sort
47+
code = bubble_sort.get_code()
48+
print(code)
49+
50+
51+
* To get the time complexity of an algorithm
52+
53+
.. code:: python
54+
55+
from pygorithm.sorting import bubble_sort
56+
time_complexity = bubble_sort.time_complexities()
57+
print(time_complexity)

0 commit comments

Comments
 (0)