~laumann/C

c6e9b8e46a30194efde542dd1c46fd3a71f5ea31 — Thomas Laumann 9 years ago 7f5a29a
removed old readme, and markdown version
3 files changed, 2 insertions(+), 162 deletions(-)

M .gitignore
D README.1
D README.md
M .gitignore => .gitignore +2 -0
@@ 1,6 1,8 @@
*.swp
*.[oa]
*~
laumann.1
README.xml
binarytree
cbook/array_traversal
cbook/ex4_3

D README.1 => README.1 +0 -95
@@ 1,95 0,0 @@
."TH [NAME of PROGRAM] [SECTION NUMBER] [CENTER FOOTER] [LEFT FOOTER] [CENTER HEADER]
.TH laumann 1 "May 2011" "Version 0.1" "Laumann C Library"
.SH NAME
Laumann C Library \- A library of C programs, created for/while learning C by Thomas B. Laumann Jespersen
.SH SYNOPSIS
.PP
.B make
[help]
.PP
Use the
.IR Makefile s
found in the different directories to get an idea, of what they are for. The default target for all these directories will be the
.I help
target, printing some sort of useful information.

.SH DESCRIPTION
This "library" is written as an exercise in learning C, mostly using
.B The C
.BR Book ,
but other resources have also been in use.
.PP
This collection has developed alongside the reading of
.B The C Book
and all of the programs called
.B exampleX_Y
or
.B exerciseX_Y
where
.B X
and
.B Y
are integers, are taken directly from the aforementioned book. A few of these programs don't work, which is because is because they are erroneous in the book (I have checked and double checked).
.PP
Other programs are my own creations, like
.BR redblacktree ,
a red-black tree implementation (which, as of version 0.1 doesn't work properly - I haven't found the error yet),
.B binarytree
(actually a binary search tree) and
.BR write .

.SH LIBRARY OVERVIEW
Here is a list of the directories contained in this library and a short description of them.
.TP
.B begin
To begin at the beginning. This directory has a lot of simple "Getting Started" programs ("Hello, World!" and the like).
.TP
.B cbook
The next step. The exercises I deemed a bit more advanced, or only interesting if you were reading the book.
.TP
.B trigrapher
Take as input a C program and output the same program substituting all characters that can be represented by trigraphs with their trigraph equivalents.
.TP
.B redblacktree
A red-black tree implementation. This implementation is faulty, because printing an in-order traversal of the tree might not yield its elements in a sorted order. The bug (I believe) is found in the rotations, maybe it's a race condition of a kind.
.TP
.B binarytree
A binary search tree implementation.
.TP
.B linkedlist
A (doubly) linked list implementation.
.TP
.B recursive_descent_parser
or
.BR rdep ,
a recursive descent expression parser (for standard C integer expressions).
.TP
.B pattern
A pattern matching program. This program is taken from the penultimate section of
.B The C
.BR Book ,
and is a simplistic grep-like program.
.TP
.B write
A simple program that writes the given arguments to a file or to
.I stdout
(default is
.IR stdout ).
The idea behind this program was to take some inspiration from 
.B git
about command line arguments and the use of bit operations to indicate set options.
.TP
.B progress
A progress bar, shamelessly stolen from 
.BR git ,
because I think it's cool and wanted to see if I could get it to work outside 
.BR git .
.SH AUTHOR
Thomas Bracht Laumann Jespersen <laumann.thomas@gmail.com>

.SH SEE ALSO
.B The C Book
from
.B GBdirect
(the book can be downloaded in PDF form from:
.IR http://publications.gbdirect.co.uk/c_book/ )

D README.md => README.md +0 -67
@@ 1,67 0,0 @@
laumann(1) "May 2011" "Version 0.1" "Laumann C Library"
=======================================================

NAME
----
Laumann C Library \- A library of C programs, created for/while learning C by Thomas B. Laumann Jespersen

SYNOPSIS
--------

**make** [help]

Use the _Makefile_ s found in the different directories to get an idea, of what they are for. The default target for all these directories will be the _help_ target, printing some sort of useful information.

DESCRIPTION
-----------

This "library" is written as an exercise in learning C, mostly using **The C Book**, but other resources have also been in use.

This collection has developed alongside the reading of **The C Book** and all of the programs called **exampleX_Y** or **exerciseX_Y** where **X** and **Y**
are integers, are taken directly from the aforementioned book. A few of these programs don't work, which is because is because they are erroneous in the book (I have checked and double checked).

Other programs are my own creations, like **redblacktree**, a red-black tree implementation (which, as of version 0.1 doesn't work properly - I haven't found the error yet), **binarytree** (actually a binary search tree) and **write**.

LIBRARY OVERVIEW
----------------

Here is a list of the directories contained in this library and a short description of them.

**begin**
 : To begin at the beginning. This directory has a lot of simple "Getting Started" programs ("Hello, World!" and the like).

**cbook**
 : The next step. The exercises I deemed a bit more advanced, or only interesting if you were reading the book.

**trigrapher**
 : Take as input a C program and output the same program substituting all characters that can be represented by trigraphs with their trigraph equivalents.

**redblacktree**
 : A red-black tree implementation. This implementation is faulty, because printing an in-order traversal of the tree might not yield its elements in a sorted order. The bug (I believe) is found in the rotations, maybe it's a race condition of a kind.

**binarytree**
 : A binary search tree implementation.

**linkedlist**
 : A (doubly) linked list implementation.

**recursive_descent_parser** or **rdep**
 : a recursive descent expression parser (for standard C integer expressions).

**pattern**
 : A pattern matching program. This program is taken from the penultimate section of **The C Book**, and is a simplistic grep-like program.

**write**
 : A simple program that writes the given arguments to a file or to _stdout_ (default is _stdout_). The idea behind this program was to take some inspiration from **git** about command line arguments and the use of bit operations to indicate set options.

**progress**
 : A progress bar, shamelessly stolen from **git**, because I think it's cool and wanted to see if I could get it to work outside **git**.

AUTHOR
------
Thomas Bracht Laumann Jespersen <laumann.thomas@gmail.com>

SEE ALSO
--------

**The C Book** from **GBdirect** (the book can be downloaded in PDF form from: http://publications.gbdirect.co.uk/c_book/ )