From d77af892ee2d8ad89caeef5519b51b0e2cd55d72 Mon Sep 17 00:00:00 2001 From: Pierre Pronchery Date: Tue, 2 Feb 2016 00:28:57 +0100 Subject: [PATCH] Add a README file --- README.md | 34 ++++++++++++++++++++++++++++++++++ project.conf | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bdd89a8 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +DeforaOS libApp +=============== + +About libApp +------------ + +libApp is a message-passing framework. It is designed to become the core +component for the DeforaOS Project, providing transparent and protocol-agnostic +network computing capabilities. Regardless, libApp is intended to be portable +and work on any system, using any POSIX-compliant runtime as fallback if +available. + + +Compiling libApp +---------------- + +Before being able to build libApp, it is necessary to generate Makefiles with +`configure(1)` from the DeforaOS configure project, found at +. It should be enough to run +this tool as follows: + + $ configure + +Please refer to the documentation of DeforaOS configure for further +instructions. + +It is then possible to build the project with `make(1)` as usual. The following +command should therefore be enough: + + $ make + +To install libApp in a dedicated directory, like `/path/to/libApp`: + + $ make PREFIX="/path/to/libApp" install diff --git a/project.conf b/project.conf index 61ab4a6..b99e766 100644 --- a/project.conf +++ b/project.conf @@ -1,6 +1,6 @@ package=libApp version=0.3.0 config=h,sh -dist=Makefile,COPYING,config.h,config.sh +dist=Makefile,COPYING,README.md,config.h,config.sh subdirs=data,doc,include,src,src/transport,tools,tests