Skip to content
This repository was archived by the owner on Nov 6, 2018. It is now read-only.

Commit 176b874

Browse files
committed
Changed formatting for rendering PyPI. Updated install instructions.
1 parent 6cf7134 commit 176b874

File tree

1 file changed

+37
-35
lines changed

1 file changed

+37
-35
lines changed

README.rst

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Algorithms: a module of useful algorithms for Python
2-
====================================================
1+
Algorithms
2+
==========
33

4-
This is an attempt to build a cohesive module of algorithms in Python.
4+
This is an attempt to build a cohesive module of algorithms in Python.
55

66
The purpose of this repo is to be a learning tool for myself and others.
77

@@ -11,69 +11,69 @@ Algorithms implemented so far:
1111
------------------------------
1212

1313
**Sorting:**
14-
- Bogo Sort
15-
- Bubble Sort
16-
- Cocktail Sort
17-
- Comb Sort
18-
- Heap Sort
19-
- Insertion Sort
20-
- Merge Sort
21-
- Quick Sort
22-
- Selection Sort
23-
- Shell Sort
14+
15+
- Bogo Sort
16+
- Bubble Sort
17+
- Cocktail Sort
18+
- Comb Sort
19+
- Heap Sort
20+
- Insertion Sort
21+
- Merge Sort
22+
- Quick Sort
23+
- Selection Sort
24+
- Shell Sort
2425

2526
**Searching:**
26-
- Binary Search
27-
- Boyer-Moore-Horspool
28-
- Knuth-Morris-Pratt
29-
- Rabin-Karp
27+
28+
- Binary Search
29+
- Boyer-Moore-Horspool
30+
- Knuth-Morris-Pratt
31+
- Rabin-Karp
3032

3133
**Shuffling:**
32-
- Knuth/Fisher-Yates Shuffle
3334

34-
**Math:**
35-
- Extended GCD
35+
- Knuth/Fisher-Yates Shuffle
3636

37-
Installation:
38-
-------------
39-
40-
To clone the repository in to your working directory:
37+
**Math:**
4138

42-
.. code::
39+
- Extended GCD
4340

44-
$ git clone https://github.com/nryoung/algorithms.git
4541

46-
Requirements are listed in :code:`requirements.txt`.
42+
Installation:
43+
-------------
4744

48-
If you are using pip and virtualenv you can simply do:
45+
To install, simply
4946

50-
.. code::
47+
::
5148

52-
$ pip install -r requirements.txt
49+
$ pip install algorithms
5350

5451

5552
Usage:
5653
------
5754

58-
Once cloned you can simply do the following in your program:
55+
Once installed you can simply do the following in your program:
5956

60-
.. code:: python
57+
::
6158

6259
from algorithms.sorting import bubble_sort
6360

6461
my_list = bubble_sort.sort(my_list)
6562

63+
6664
All prequisites for the algorithms are listed in the source code for each algorithm.
6765

66+
6867
Tests:
6968
------
7069

7170
Nose is used as the main test runner and all Unit Tests can be run by:
7271

73-
.. code::
72+
::
7473

7574
$ python algorithms/run_tests.py
7675

76+
7777
Contributing:
7878
-------------
7979

@@ -82,12 +82,14 @@ If there is an algorithm or data structure that you do not see, but would like t
8282
1. For each algorithm and data structure you implement please have corresponding unit tests to prove correctness.
8383
2. Please make sure that your module follows similar style guidelines that are laid out in the other modules.
8484

85-
I want to personally thank everybody that has contributed so far and your names will be added to :code:`AUTHORS.rst`.
85+
I want to personally thank everybody that has contributed so far and your names will be added to `AUTHORS.rst`.
86+
8687

8788
TODO:
8889
-----
8990

90-
See :code:`TODO.rst`.
91+
See `TODO.rst`.
92+
9193

9294
License:
9395
--------

0 commit comments

Comments
 (0)