diff options
authorBoris Kolpackov <boris@codesynthesis.com>2016-03-14 16:39:27 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-03-14 16:39:27 +0200
commit006b614a4e5422b75f78ca0654f068b17ecd300d (patch)
parent046c4d8017a2c709f506816d4f73d734ccbeaef7 (diff)
Add README file
2 files changed, 26 insertions, 1 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2e75a4f
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+This package contains the build2 package manager 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:
+This library defines the types and utilities for working with build2 packages.
+In particular, it provides C++ classes as well as the parser and serializer
+implementations that can be used to read, manipulate, and write package and
+repository manifests.
+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 searchable archives, posting guidelines, etc.
diff --git a/buildfile b/buildfile
index 524c205..92a454c 100644
--- a/buildfile
+++ b/buildfile
@@ -3,7 +3,7 @@
# license : MIT; see accompanying LICENSE file
d = bpkg/ tests/
-./: $d doc{LICENSE version} file{manifest}
+./: $d doc{LICENSE README version} file{manifest}
include $d
doc{INSTALL*}: install = false