Skip to content

Commit 033e64f

Browse files
committed
Add Travis badge, formatting
1 parent dae5730 commit 033e64f

File tree

1 file changed

+34
-43
lines changed

1 file changed

+34
-43
lines changed

README.markdown

+34-43
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# algorithms
22

3-
* Official homes are here on github, and at [rubyforge](http://rubyforge.org/projects/algorithms/)
4-
* Documentation: [http://algorithms.rubyforge.org/](http://algorithms.rubyforge.org/)
3+
[![Build Status](https://travis-ci.org/kanwei/algorithms.png)](https://travis-ci.org/kanwei/algorithms)
54

65
## DESCRIPTION:
76

@@ -18,54 +17,46 @@ This project will create such a library with documentation on when to use a
1817
particular structure/algorithm. It will also come with a benchmark suite to
1918
compare performance in different situations.
2019

21-
## FEATURES:
22-
23-
Done so far:
24-
25-
* Heaps Containers::Heap, Containers::MaxHeap, Containers::MinHeap
26-
* Priority Queue Containers::PriorityQueue
27-
* Deque Containers::Deque, Containers::CDeque (C extension), Containers::RubyDeque
28-
* Stack Containers::Stack (uses Deque)
29-
* Queue Containers::Queue (uses Deque)
30-
* Red-Black Trees Containers::RBTreeMap, Containers::CRBTreeMap (C extension), Containers::RubyRBTreeMap
31-
* Splay Trees Containers::SplayTreeMap, Containers::CSplayTreeMap (C extension), Containers::RubySplayTreeMap
32-
* Tries Containers::Trie
33-
* Suffix Array Containers::SuffixArray
34-
* kd Tree Containers::KDTree
35-
36-
* Search algorithms
37-
- Binary Search Algorithms::Search.binary_search
38-
- Knuth-Morris-Pratt Algorithms::Search.kmp_search
39-
* Sort algorithms
40-
- Bubble sort Algorithms::Sort.bubble_sort
41-
- Comb sort Algorithms::Sort.comb_sort
42-
- Selection sort Algorithms::Sort.selection_sort
43-
- Heapsort Algorithms::Sort.heapsort
44-
- Insertion sort Algorithms::Sort.insertion_sort
45-
- Shell sort Algorithms::Sort.shell_sort
46-
- Quicksort Algorithms::Sort.quicksort
47-
- Mergesort Algorithms::Sort.mergesort
20+
## COMPLETED:
21+
22+
* Heaps Containers::Heap, Containers::MaxHeap, Containers::MinHeap
23+
* Priority Queue Containers::PriorityQueue
24+
* Deque Containers::Deque, Containers::CDeque (C extension), Containers::RubyDeque
25+
* Stack Containers::Stack (uses Deque)
26+
* Queue Containers::Queue (uses Deque)
27+
* Red-Black Trees Containers::RBTreeMap, Containers::CRBTreeMap (C extension), Containers::RubyRBTreeMap
28+
* Splay Trees Containers::SplayTreeMap, Containers::CSplayTreeMap (C extension), Containers::RubySplayTreeMap
29+
* Tries Containers::Trie
30+
* Suffix Array Containers::SuffixArray
31+
32+
* Search algorithms
33+
- Binary Search Algorithms::Search.binary_search
34+
- Knuth-Morris-Pratt Algorithms::Search.kmp_search
35+
* Sort algorithms
36+
- Bubble sort Algorithms::Sort.bubble_sort
37+
- Comb sort Algorithms::Sort.comb_sort
38+
- Selection sort Algorithms::Sort.selection_sort
39+
- Heapsort Algorithms::Sort.heapsort
40+
- Insertion sort Algorithms::Sort.insertion_sort
41+
- Shell sort Algorithms::Sort.shell_sort
42+
- Quicksort Algorithms::Sort.quicksort
43+
- Mergesort Algorithms::Sort.mergesort
4844

4945
## SYNOPSIS:
5046

51-
require 'rubygems'
52-
require 'algorithms'
53-
54-
max_heap = Containers::MaxHeap.new
55-
56-
# To not have to type "Containers::" before each class, use:
57-
include Containers
58-
max_heap = MaxHeap.new
47+
require 'rubygems'
48+
require 'algorithms'
5949

50+
max_heap = Containers::MaxHeap.new
6051

61-
## REQUIREMENTS:
62-
63-
* Ruby 1.8 compatible Ruby, or Ruby 1.9
64-
* C compiler for C extensions (optional, but very much recommended for vast performance benefits)
52+
# To not have to type "Containers::" before each class, use:
53+
include Containers
54+
max_heap = MaxHeap.new
6555

66-
## INSTALL:
56+
## REQUIREMENTS:
6757

68-
* sudo gem install algorithms
58+
* Ruby 1.8, Ruby 1.9, JRuby
59+
* C extensions (optional, but very much recommended for vast performance benefits)
6960

7061
## LICENSE:
7162

0 commit comments

Comments
 (0)