aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-03-14 14:39:27 (GMT)
committerBoris Kolpackov <boris@codesynthesis.com>2016-03-14 14:39:27 (GMT)
commit6fd19ac890fce667025944c84fc001c78aac8366 (patch)
treee71610187a149d9a2f312bf1dd830967f144c4e2
parentd1bd79770900f3b873f60d7559b97d2fb149eaf9 (diff)
Add README file
-rw-r--r--README23
-rw-r--r--buildfile2
2 files changed, 24 insertions, 1 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..99a5941
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+This package contains the build2 utility library.
+
+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/
+
+This library is a collection of utilities that are used throughout the
+toolchain.
+
+See the NEWS file for the user-visible changes from the previous release.
+
+See the LICENSE file for the distribution conditions.
+
+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 details.
diff --git a/buildfile b/buildfile
index ee3def6..29beab5 100644
--- a/buildfile
+++ b/buildfile
@@ -3,7 +3,7 @@
# license : MIT; see accompanying LICENSE file
d = butl/ tests/
-./: $d doc{LICENSE version} file{manifest}
+./: $d doc{LICENSE README version} file{manifest}
include $d
doc{INSTALL*}: install = false