aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-03-14 16:39:27 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-03-14 16:39:27 +0200
commit6b549610ef9fc72fe07babf5f65272bc4eb3759b (patch)
treee9f4c8c569177fdd1f5f2d236f83ce9328f2dcb9
parentd08f27ecda03b5b05f34e9ae91f62e9aebb5e569 (diff)
Add README file
-rw-r--r--README18
-rw-r--r--buildfile2
2 files changed, 19 insertions, 1 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f923c25
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+This is the build2 toolchain amalgamation. It includes the build system
+(build2), package manager (bpkg), and their prerequisite libraries (libbutl
+and libbpkg).
+
+build2 is an open source, cross-platform toolchain for building and packaging
+C++ code. Its aim is a modern build system and package manager for the C++
+language that provide a consistent, out of the box interface across multiple
+platforms and compilers. For more information see:
+
+https://build2.org/
+
+See the INSTALL file for the prerequisites and installation instructions.
+
+See the doc/ directory for documentation.
+
+Send questions, bug reports, or any other feedback to the users@build2.org
+mailing list. You can post without subscribing. See https://lists.build2.org
+for searchable archives, posting guidelines, etc.
diff --git a/buildfile b/buildfile
index 3225679..3a3d3fc 100644
--- a/buildfile
+++ b/buildfile
@@ -3,7 +3,7 @@
# license : MIT; see accompanying LICENSE file
d = libbutl/ build2/ libbpkg/ bpkg/ doc/
-./: $d doc{INSTALL version} file{INSTALL.cli}
+./: $d doc{INSTALL README version} file{INSTALL.cli}
include $d
doc{INSTALL*}: install = false