Convert doc files to Markdown

fragglet · Dec 17, 2024 · e601cc1 · e601cc1
1 parent 0d81e2c
commit e601cc1
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 67 deletions.
diff --git a/COPYING b/COPYING
diff --git a/COPYING.md b/COPYING.md
@@ -0,0 +1,17 @@
+ISC License
+
+Copyright (c) 2005-2008, Simon Howard
+
+Permission to use, copy, modify, and/or distribute this software
+for any purpose with or without fee is hereby granted, provided
+that the above copyright notice and this permission notice appear
+in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/Makefile.am b/Makefile.am
@@ -1,7 +1,13 @@
 
 AUX_DIST_GEN = $(ac_aux_dir)
 
-EXTRA_DIST = $(AUX_DIST_GEN) libcalg-1.0.pc.in STYLE.md .clang-format
+DOC_FILES=            \
+        COPYING.md    \
+        NEWS.md       \
+        README.md     \
+        STYLE.md
+
+EXTRA_DIST = $(AUX_DIST_GEN) libcalg-1.0.pc.in $(DOC_FILES) .clang-format
 MAINTAINERCLEANFILES = $(AUX_DIST_GEN)
 
 pkgconfigdir = $(libdir)/pkgconfig

diff --git a/NEWS b/NEWS
diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,46 @@
+
+## v1.2.0   (14th September 2008)
+
+ * The license has been changed to the ISC license.
+ * Support for compiling with gcc coverage options and running tests in
+   valgrind.
+ * All headers now have extern "C" definitions for use in C++ programs.
+ * Trie free function uses a non-recursive algorithm to avoid the possibility
+   of stack overflow.
+
+Test suite:
+ * Framework added for testing memory allocation/free.
+ * Tests have been fixed to properly free any memory allocated during
+   execution of the test.
+ * Tests have been expanded to increase the code coverage.
+ * A test case has been added for testing use of the program in C++
+   programs.
+
+Bugs fixed:
+ * Memory leak in hash table.
+ * Bugs with the AVL tree.
+ * Trie responds to out of memory scenarios correctly.
+
+## v1.1.0   (1st June 2008)
+
+ * Added data structures:
+   - Binary Heap
+   - Binomial Heap
+   - Bloom Filter
+ * Iterator functions changed to a model based around an iterator structure
+   rather than callback functions.
+ * Void pointers used for keys/values replaced by typedefs to void pointers.
+   This allows the type to be changed to something else if desired.
+ * Hash table sizes changed to use a set of recommended prime numbers that are
+   mathematically good for use in hash tables:
+     http://planetmath.org/encyclopedia/GoodHashTablePrimes.html
+ * Tests added for some code that was not covered by the test suite.
+ * Failed malloc() calls are now checked for.
+ * Bugs fixed:
+   - Lockup with set_remove function.
+   - set_to_array did not include all values.
+
+## v1.0.0   (30th January 2006)
+
+First release.
+
diff --git a/README → README.md b/README → README.md
@@ -1,5 +1,4 @@
-
-C Algorithms
+## C Algorithms
 
 The C programming language includes a very limited standard library in
 comparison to other modern programming languages.  This is a collection of

diff --git a/configure.ac b/configure.ac
@@ -4,7 +4,7 @@ AC_CONFIG_SRCDIR([src/arraylist.c])
 AC_CONFIG_MACRO_DIR([m4])
 m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
 
-AM_INIT_AUTOMAKE
+AM_INIT_AUTOMAKE([foreign])
 
 AC_PROG_CC
 AM_PROG_CC_C_O