diff --git a/README b/README index 739c991d9d..0490d3d48d 100644 --- a/README +++ b/README @@ -1,29 +1,80 @@ -OpenLDAP Devel README - This software was obtained from a development branch of the - OpenLDAP Software Repository. This copy is likely already - not current, the development branch changes frequently. These - changes include code implementing experimental features and - unproven bug fixes. Please do NOT redistribute copies of the - development branch. +OpenLDAP 2.6 README + For a description of what this distribution contains, see the + ANNOUNCEMENT file in this directory. For a description of + changes from previous releases, see the CHANGES file in this + directory. - The OpenLDAP Developer's FAQ is available at: - + This is 2.6 release, it includes significant changes from prior + releases. - Client developers seeking a suitable development platform - should use "release" or "stable" versions. - +REQUIRED SOFTWARE + Building OpenLDAP Software requires a number of software packages + to be preinstalled. Additional information regarding prerequisite + software can be found in the OpenLDAP Administrator's Guide. -Contributing - See for how to - contribute code or documentation to OpenLDAP. Use the Issue Tracking - System to submit contributions. - While you are encouraged to coordinate and discuss the development - activities on the openldap-devel@openldap.org mailing list prior - to submission, it is noted that contributions must be submitted - using the Issue Tracking System to be considered. + Base system (libraries and tools): + Standard C compiler (required) + Cyrus SASL 2.1.27+ (recommended) + OpenSSL 1.1.1+ (recommended) + libevent 2.1.8+ (recommended) + libargon2 or libsodium (recommended) + Reentrant POSIX REGEX software (required) + + SLAPD: + The ARGON2 password hashing module requires either libargon2 + or libsodium + LLOADD: + The LLOADD daemon or integrated slapd module requires + libevent 2.1.8 or later. + + CLIENTS/CONTRIB ware: + Depends on package. See per package README. + + +MAKING AND INSTALLING THE DISTRIBUTION + Please see the INSTALL file for basic instructions. More + detailed instructions can be found in the OpenLDAP Administrator's + Guide (see DOCUMENTATION section). + + +DOCUMENTATION + The OpenLDAP Administrator's Guide is available in the + guide.html file in the doc/guide/admin directory. The + guide and a number of other documents are available at + . + + The distribution also includes manual pages for most programs + and library APIs. See ldap(3) for details. + + The OpenLDAP website is available and contains the latest LDAP + news, releases announcements, pointers to other LDAP resources, + etc.. It is located at . + + +SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + OpenLDAP Software is user supported. If you have problems, please + review the OpenLDAP FAQ and + archives of the OpenLDAP-software and OpenLDAP-bugs mailing lists + . If you cannot find the answer, + please enquire on the OpenLDAP-software list. + + Issues, such as bug reports, should be reported using our + Issue Tracking System . Do not + use this system for software enquiries. Please direct these + to an appropriate mailing list. + + +CONTRIBUTING + See for + information regarding how to contribute code or documentation + to the OpenLDAP Project for inclusion in OpenLDAP Software. + While you are encouraged to coordinate and discuss the development + activities on the mailing list + prior to submission, it is noted that contributions must be + submitted using the Issue Tracking System + to be considered. --- -$OpenLDAP$ This work is part of OpenLDAP Software .