Permalink
Browse files

Expand README with introduction and usage

  • Loading branch information...
1 parent 828d2b4 commit ceb456312469253975afc14539b7157e778214f7 @caio committed Mar 28, 2012
Showing with 25 additions and 0 deletions.
  1. +25 −0 README
View
25 README
@@ -1,23 +1,48 @@
+INTRODUCTION
+============
+
+fuzzyclock is a simple program written in C to output the current time
+in a "fuzzy format", i.e.: instead of outputting 4:17, it will write
+out "fifteen past four".
+
+This program was written as an exercise for learning about the Check
+testing framework and refreshing my (rather basic) autotools knowledge.
+
+
+USAGE
+=====
+
+In the command line:
+
+ fuzzyclock
+
+You can also use the libfuzzyclock.a library in your software. Check
+src/fuzzyclock.h for the exported functions.
+
+
BUILDING FROM GIT
=================
autoreconf --install
./configure
make
+
BUILDING FROM SOURCES
=====================
./configure
make
+
RUNNING TESTS
=============
Note: Check (check.sourceforge.net) is required
make check
+
INSTALLING
==========

0 comments on commit ceb4563

Please sign in to comment.