From 4cbc8df7c871f1ca4938fa37afe599e00c3e371b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= Date: Sat, 31 Oct 2020 16:18:46 +0000 Subject: [PATCH] Add some details to README. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..20729da --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +ognibuild +========= + +Ognibuild is a simple wrapper with a common interface for invoking any kind of +build tool. + +The ideas is that it can be run to build and install any source code directory +by detecting the build system that is in use and invoking that with the correct +parameters. + +It can also detect and install missing dependencies. + +Goals +----- + +The goal of ognibuild is to provide a consistent CLI that can be used for any +software package. It is mostly useful for automated building of +large sets of diverse packages (e.g. different programming languages). + +It is not meant to expose all functionality that is present in the underlying +build systems. To use that, invoke those build systems directly. + +Usage +----- + +Ognibuild has a number of subcommands: + + * ``ogni clean`` - remove any built artifacts + * ``ogni dist`` - create a source tarball + * ``ogni build`` - build the package in-tree + * ``ogni install`` - install the package + * ``ogni test`` - run the testsuite in the source directory + +License +------- + +Ognibuild is licensed under the GNU GPL, v2 or later.