瀏覽代碼

update the readme file

Ioannis Koutras 12 年之前
父節點
當前提交
f530d46558
共有 2 個文件被更改,包括 9 次插入29 次删除
  1. 0 24
      README
  2. 9 5
      README.md

+ 0 - 24
README

@@ -1,24 +0,0 @@
-NTUA / ICCS dmmlib
-
-Distributed within the context of 2PARMA project (http://www.2parma.eu)
-
-Requirements:
-=============
-
-* cmake v2.6 or higher
-* GCC compiler v3.4 or higher
-
-Usage:
-======
-
-1. Create the build directory, e.g. "mkdir build"
-2. Go to the build directory, e.g. "cd build"
-3. Do cmake {DMMLIB Source Directory} -DLINUXTEST=ON , e.g. "cmake .. -DLINUXTEST=ON"
-4. "make"
-5. Link the library to your application, e.g. "gcc -I{DMMLIB Source Directory}/include -I{DMMLIB Build Directory} {DMMLIB Build Directory}/libdmm_static.a yourapp.c -o yourapp"  
-
-Contact Information:
-====================
-
-Ioannis Koutras (joko@microlab.ntua.gr)
-Alex Bartzas (alexis@microlab.ntua.gr)

+ 9 - 5
README.md

@@ -1,25 +1,29 @@
 # NTUA / ICCS dmmlib
 
-Distributed within the context of the [2PARMA project](http://www.2parma.eu).
+**dmmlib** is a a dynamic memory management framework developped in C.
+For more information please visit [the official site](http://dmmlib.microlab.ntua.gr) of the project.
+dmmlib is currently distributed within the context of the [2PARMA project](http://www.2parma.eu).
 
 ## Requirements
 
 * cmake v2.6 or higher
-* GCC compiler v3.4 or higher
+* C99-compliant compiler (tested on GCC toolchains of version 3.4 or higher)
 
 ## Usage
 
 1. Create the build directory, e.g. _mkdir build_
 2. Go to the build directory, e.g. _cd build_
-3. Do cmake {DMMLIB Source Directory} -DLINUXTEST=ON , e.g. _cmake .. -DLINUXTEST=ON_
+3. Do cmake {DMMLIB Source Directory} -DLINUX=ON , e.g. _cmake .. -DLINUX=ON_
 4. _make_
 
 ## Linking with applications
 
-There are currently two options:
+There are currently three options:
 
-* Link the library to your application  
+* Link the library statically to your application  
 _gcc -I{DMMLIB Source Directory}/include -I{DMMLIB Build Directory} {DMMLIB Build Directory}/libdmm\_static.a yourapp.c -o yourapp_
+* Link the library dynamically to your application
+ _gcc -I{DMMLIB Source Directory}/include -L{DMMLIB Build Directory}/src -ldmm yourapp.c -o yourapp_
 * Use the dynamic linker to preload dmmlib during application's execution:  
 _LD\_PRELOAD={DMMLIB Build Directory}/src/libdmm\_shared.so application_