Permalink
Browse files

[makl] added INSTALL file

  • Loading branch information...
1 parent ec084d2 commit 1bf44f9eaf6ed823c66a4f3a3ac4b101ee622844 tho committed Dec 4, 2006
Showing with 66 additions and 63 deletions.
  1. +61 −0 INSTALL
  2. +2 −2 Makefile.dist
  3. +3 −61 README
View
@@ -0,0 +1,61 @@
+== Toolchain and Shared Libraries Setup ==
+
+$ $(GNUMAKE) toolchain
+
+This is the very first step by which MaKL Self detects the host platform and
+installs the appropriate toolchain files.
+
+
+== Prepare for Installation ==
+
+$ ./configure --gnu_make=/path/to/gnu/make \
+ --prefix=/path/to/makl/dest/dir
+
+While '--gnu_make=...' parameter is mandatory and must be set to the exact path
+of an installed GNU make executable (perhaps the same used in the toolchain
+step, '--prefix=...' is optional and defaults to '/usr/local'.
+
+MaKL template libraries (i.e. mk and cf modules) will be placed into
+$(prefix)/share/makl-$(MAKL_VERSION).
+The 'maklsh' executable and its related symlinks ('makl', 'maklconf' and
+'maklhelp') will reside into $(prefix)/bin/
+
+
+== Installation ==
+
+# make install
+
+add $(prefix)/bin/ to your PATH env variable and you will be able to use the
+'makl' and 'maklconf' commands to build and configure your C/C++ projects.
+
+
+== Supplementary Steps ==
+
+If you need to override system-wide settings, perhaps in order to use a
+specific MaKL version you can create a '.maklrc' file containing the appropriate
+variables and let 'maklsh' use them. Suppose you have MaKL installed at
+/share/makl-1.5.0/ and you want to use a newer MaKL version which you have
+downloaded and installed in your home directory. Then do the following:
+
+$ makl -C /usr/local/share/makl-1.5.0/ env
+Pick up a shell [bash]: zsh
+Pick a suitable environment file [/share/makl-1.5.0/makl.env]: /home/me/.maklrc
+
+then open '/home/me/.maklrc' in your favourite editor (mine is vim :-)) and
+set the variables to match your "private" MaKL setting:
+
+$ vim /home/me/.maklrc
+====
+MAKL_VERSION="1.6.0"
+export MAKL_VERSION
+
+MAKL_DIR="/home/tho/work/share/makl-1.6.0"
+export MAKL_DIR
+
+MAKEFLAGS="-I ${MAKL_DIR}/mk"
+export MAKEFLAGS
+
+# Set this to expand the config scripts search
+MAKL_CF_SCRIPTS="./myproject-configure"
+export MAKL_CF_SCRIPTS
+====
View
@@ -1,11 +1,11 @@
-# $Id: Makefile.dist,v 1.16 2006/12/01 15:48:50 tho Exp $
+# $Id: Makefile.dist,v 1.17 2006/12/04 08:40:34 tho Exp $
include common.mk
PKG_NAME = makl
PKG_VERSION = $(shell cat VERSION)
-DISTFILES = Makefile VERSION README LICENSE ChangeLog
+DISTFILES = Makefile VERSION README LICENSE ChangeLog INSTALL
DISTFILES += configure configure.help
# auto configuration (cf files)
View
@@ -1,63 +1,5 @@
-== Toolchain and Shared Libraries Setup ==
-
-$ $(GNUMAKE) toolchain
-
-This is the very first step by which MaKL Self detects the host platform and
-installs the appropriate toolchain files.
-
-
-== Prepare for Installation ==
-
-$ ./configure --gnu_make=/path/to/gnu/make \
- --prefix=/path/to/makl/dest/dir
-
-While '--gnu_make=...' parameter is mandatory and must be set to the exact path
-of an installed GNU make executable (perhaps the same used in the toolchain
-step, '--prefix=...' is optional and defaults to '/usr/local'.
-
-MaKL template libraries (i.e. mk and cf modules) will be placed into
-$(prefix)/share/makl-$(MAKL_VERSION).
-The 'maklsh' executable and its related symlinks ('makl', 'maklconf' and
-'maklhelp') will reside into $(prefix)/bin/
-
-
-== Installation ==
-
-# make install
-
-add $(prefix)/bin/ to your PATH env variable and you will be able to use the
-'makl' and 'maklconf' commands to build and configure your C/C++ projects.
-
-
-== Supplementary Steps ==
-
-If you need to override system-wide settings, perhaps in order to use a
-specific MaKL version you can create a '.maklrc' file containing the appropriate
-variables and let 'maklsh' use them. Suppose you have MaKL installed at
-/share/makl-1.5.0/ and you want to use a newer MaKL version which you have
-downloaded and installed in your home directory. Then do the following:
-
-$ makl -C /usr/local/share/makl-1.5.0/ env
-Pick up a shell [bash]: zsh
-Pick a suitable environment file [/share/makl-1.5.0/makl.env]: /home/me/.maklrc
-
-then open '/home/me/.maklrc' in your favourite editor (mine is vim :-)) and
-set the variables to match your "private" MaKL setting:
-
-$ vim /home/me/.maklrc
-====
-MAKL_VERSION="1.6.0"
-export MAKL_VERSION
-
-MAKL_DIR="/home/tho/work/share/makl-1.6.0"
-export MAKL_DIR
-
-MAKEFLAGS="-I ${MAKL_DIR}/mk"
-export MAKEFLAGS
-
-# Set this to expand the config scripts search
-MAKL_CF_SCRIPTS="./myproject-configure"
-export MAKL_CF_SCRIPTS
-====
+Documentation can be found in the MaKL section of the KoanLogic wiki:
+ http://wiki.koanlogic.com/doku.php?id=makl
+Help us improving and keeping up to date MaKL doc bits !

0 comments on commit 1bf44f9

Please sign in to comment.