From 1d1409b62bb0a479b4c517bd9cf0e4aeab7119c9 Mon Sep 17 00:00:00 2001 From: Tobias Schuele Date: Fri, 10 Oct 2014 11:23:14 +0200 Subject: [PATCH] Added section on development and contribution in README.md. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a6bd8e0..b5c612f 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,10 @@ data structures for storing object in an organized and thread-safe way. Build and Installation ====================== +Note: It is recommended to build from a packaged release file and not from a +snapshot of the repository in order to get the documentation and the examples +out-of-the box. + EMBĀ² is built using CMake (version 2.8.9 or higher). CMake is a build file generator which allows to abstract from the concrete build tools. To generate and invoke the platform-specific build files, open a shell (on Windows, use @@ -296,6 +300,14 @@ Known Bugs and Limitations embb::base::Thread). +Development and Contribution +============================ + +The EMBĀ² team welcomes all kinds of contributions, preferably as pull requests +or patches via the development mailing lists (see above). If possible, please +refer to a current snapshot of the development branch. + + Links ===== -- libgit2 0.26.0