From 73c33cf2c215759b3cb0c1427bd3887c256351ab Mon Sep 17 00:00:00 2001 From: Pierre Pronchery Date: Mon, 19 Nov 2012 00:35:42 +0100 Subject: [PATCH] Renamed and improved the README to README.md --- Makefile | 2 +- README.md | 22 ++++++++++++++++++++++ project.conf | 2 +- 3 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/Makefile b/Makefile index 72b869b..5b1cff0 100644 --- a/Makefile +++ b/Makefile @@ -88,7 +88,7 @@ dist: $(PACKAGE)-$(VERSION)/Makefile \ $(PACKAGE)-$(VERSION)/COPYING \ $(PACKAGE)-$(VERSION)/config.sh \ - $(PACKAGE)-$(VERSION)/README \ + $(PACKAGE)-$(VERSION)/README.md \ $(PACKAGE)-$(VERSION)/project.conf $(RM) -- $(PACKAGE)-$(VERSION) diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6fddb9 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +DeforaOS libSystem +================== + +About libSystem +--------------- + +libSystem is the most essential library within DeforaOS, with the aim to become +a complete C runtime (thus obsoleting the libc and replacing its API). +Regardless of its progress in this regard, libSystem is intended to be portable +and work on any system, using any POSIX-compliant runtime provided instead. + +Compiling libSystem +------------------- + +With GCC, this should be enough: + + $ make + +To install libSystem in a dedicated directory, like `/path/to/libSystem`: + + $ make PREFIX="/path/to/libSystem" install + diff --git a/project.conf b/project.conf index dcddb0c..008c185 100644 --- a/project.conf +++ b/project.conf @@ -1,6 +1,6 @@ package=libSystem version=0.1.6 config=sh -dist=Makefile,COPYING,config.sh,README +dist=Makefile,COPYING,config.sh,README.md subdirs=data,doc,include,src,tests