diff --git a/README.md b/README.md index 286489b..8def755 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -ognibuild -========= +# ognibuild Ognibuild is a simple wrapper with a common interface for invoking any kind of build tool. @@ -10,8 +9,7 @@ parameters. It can also detect and install missing dependencies. -Goals ------ +## 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 @@ -20,8 +18,7 @@ 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 ------ +## Usage Ognibuild has a number of subcommands: @@ -34,14 +31,12 @@ Ognibuild has a number of subcommands: It also includes a subcommand that can fix up the build dependencies for Debian packages, called deb-fix-build. -Status ------- +## Status Ognibuild is functional, but sometimes rough around the edges. If you run into issues (or lack of support for a particular ecosystem), please file a bug. -Supported Build Systems -~~~~~~~~~~~~~~~~~~~~~~~ +### Supported Build Systems * Cabal * Cargo @@ -60,8 +55,7 @@ Supported Build Systems * Ruby gems * Waf -Supported package repositories -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### Supported package repositories Package repositories are used to install missing dependencies. @@ -78,7 +72,6 @@ As well one distribution repository: * apt -License -------- +## License Ognibuild is licensed under the GNU GPL, v2 or later.