Skip to content

Commit e601cc1

Browse files
committed
Convert doc files to Markdown
1 parent 0d81e2c commit e601cc1

File tree

7 files changed

+72
-67
lines changed

7 files changed

+72
-67
lines changed

COPYING

Lines changed: 0 additions & 17 deletions
This file was deleted.

COPYING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
ISC License
2+
3+
Copyright (c) 2005-2008, Simon Howard
4+
5+
Permission to use, copy, modify, and/or distribute this software
6+
for any purpose with or without fee is hereby granted, provided
7+
that the above copyright notice and this permission notice appear
8+
in all copies.
9+
10+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11+
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12+
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13+
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
14+
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
16+
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
17+
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Makefile.am

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11

22
AUX_DIST_GEN = $(ac_aux_dir)
33

4-
EXTRA_DIST = $(AUX_DIST_GEN) libcalg-1.0.pc.in STYLE.md .clang-format
4+
DOC_FILES= \
5+
COPYING.md \
6+
NEWS.md \
7+
README.md \
8+
STYLE.md
9+
10+
EXTRA_DIST = $(AUX_DIST_GEN) libcalg-1.0.pc.in $(DOC_FILES) .clang-format
511
MAINTAINERCLEANFILES = $(AUX_DIST_GEN)
612

713
pkgconfigdir = $(libdir)/pkgconfig

NEWS

Lines changed: 0 additions & 46 deletions
This file was deleted.

NEWS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
2+
## v1.2.0 (14th September 2008)
3+
4+
* The license has been changed to the ISC license.
5+
* Support for compiling with gcc coverage options and running tests in
6+
valgrind.
7+
* All headers now have extern "C" definitions for use in C++ programs.
8+
* Trie free function uses a non-recursive algorithm to avoid the possibility
9+
of stack overflow.
10+
11+
Test suite:
12+
* Framework added for testing memory allocation/free.
13+
* Tests have been fixed to properly free any memory allocated during
14+
execution of the test.
15+
* Tests have been expanded to increase the code coverage.
16+
* A test case has been added for testing use of the program in C++
17+
programs.
18+
19+
Bugs fixed:
20+
* Memory leak in hash table.
21+
* Bugs with the AVL tree.
22+
* Trie responds to out of memory scenarios correctly.
23+
24+
## v1.1.0 (1st June 2008)
25+
26+
* Added data structures:
27+
- Binary Heap
28+
- Binomial Heap
29+
- Bloom Filter
30+
* Iterator functions changed to a model based around an iterator structure
31+
rather than callback functions.
32+
* Void pointers used for keys/values replaced by typedefs to void pointers.
33+
This allows the type to be changed to something else if desired.
34+
* Hash table sizes changed to use a set of recommended prime numbers that are
35+
mathematically good for use in hash tables:
36+
http://planetmath.org/encyclopedia/GoodHashTablePrimes.html
37+
* Tests added for some code that was not covered by the test suite.
38+
* Failed malloc() calls are now checked for.
39+
* Bugs fixed:
40+
- Lockup with set_remove function.
41+
- set_to_array did not include all values.
42+
43+
## v1.0.0 (30th January 2006)
44+
45+
First release.
46+

README renamed to README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
C Algorithms
1+
## C Algorithms
32

43
The C programming language includes a very limited standard library in
54
comparison to other modern programming languages. This is a collection of

configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ AC_CONFIG_SRCDIR([src/arraylist.c])
44
AC_CONFIG_MACRO_DIR([m4])
55
m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
66

7-
AM_INIT_AUTOMAKE
7+
AM_INIT_AUTOMAKE([foreign])
88

99
AC_PROG_CC
1010
AM_PROG_CC_C_O

0 commit comments

Comments
 (0)