From bbf820b28ad121fa615040049737eb3238f54441 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Recai=20Okta=C5=9F?= Date: Sun, 25 Sep 2011 15:39:34 +0300 Subject: [PATCH] add minimal documentation --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..74c0f94 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Instructions for Debian derivatives + +- Install required packages + + $ sudo apt-get install build-essential + +- Fork this repository + +- (Preferably) Build examples and APUE library + + $ make + +- Populate your own examples in `local*` subdirectories. For example: + + $ cd local + $ $EDITOR local.c + + **Please note that the main source filename must be same as the subdirectory name (i.e. `local1/local1.c`)** + +- Build and run your example + + $ cd .. # chdir to top dir + $ make + $ local/local