diff --git a/INSTALL.md b/INSTALL.md index 0d9665999a..01c360e8d4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -58,13 +58,13 @@ To install OpenSSL, you will need: For additional platform specific requirements, solutions to specific issues and other details, please read one of these: - * [NOTES-UNIX.md](NOTES-UNIX.md) - notes for Unix like systems - * [NOTES-VMS.md](NOTES-VMS.md) - notes related to OpenVMS - * [NOTES-WINDOWS.md](NOTES-WINDOWS.md) - notes related to the Windows platform - * [NOTES-DJGPP.md](NOTES-DJGPP.md) - building for DOS with DJGPP - * [NOTES-ANDROID.md](NOTES-ANDROID.md) - building for Android platforms (using NDK) - * [NOTES-VALGRIND.md](NOTES-VALGRIND.md) - testing with Valgrind - * [NOTES-PERL.m](NOTES-PERL.md) - some notes on Perl + * [Notes for UNIX-like platforms](NOTES-UNIX.md) + * [Notes for Android platforms](NOTES-ANDROID.md) + * [Notes for Windows platforms](NOTES-WINDOWS.md) + * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md) + * [Notes for the OpenVMS platform](NOTES-VMS.md) + * [Notes on Perl](NOTES-PERL.md) + * [Notes on Valgrind](NOTES-VALGRIND.md) Notational conventions ====================== diff --git a/NOTES-ANDROID.md b/NOTES-ANDROID.md index e1e7370d26..eebf03a4c4 100644 --- a/NOTES-ANDROID.md +++ b/NOTES-ANDROID.md @@ -1,4 +1,4 @@ -NOTES FOR ANDROID PLATFORMS +Notes for Android platforms =========================== Requirement details diff --git a/NOTES-DJGPP.md b/NOTES-DJGPP.md index 157b11b478..0b23c48370 100644 --- a/NOTES-DJGPP.md +++ b/NOTES-DJGPP.md @@ -1,5 +1,5 @@ -INSTALLATION ON THE DOS PLATFORM WITH DJGPP -=========================================== +Notes for the DOS platform with DJGPP +===================================== OpenSSL has been ported to DJGPP, a Unix look-alike 32-bit run-time environment for 16-bit DOS, but only with long filename support. diff --git a/NOTES-UNIX.md b/NOTES-UNIX.md index 0928753149..0b0a531db4 100644 --- a/NOTES-UNIX.md +++ b/NOTES-UNIX.md @@ -1,8 +1,8 @@ -NOTES FOR UNIX-LIKE PLATFORMS +Notes for UNIX-like platforms ============================= For Unix/POSIX runtime systems on Windows, - please see [NOTES-WINDOWS.md](NOTES-WINDOWS.md). + please see the [Notes for Windows platforms](NOTES-WINDOWS.md). OpenSSL uses the compiler to link programs and shared libraries --------------------------------------------------------------- diff --git a/NOTES-VALGRIND.md b/NOTES-VALGRIND.md index 00647cbd9b..a37e323e23 100644 --- a/NOTES-VALGRIND.md +++ b/NOTES-VALGRIND.md @@ -1,5 +1,5 @@ -NOTES FOR VALGRIND -================== +Notes on Valgrind +================= Valgrind is a test harness that includes many tools such as memcheck, which is commonly used to check for memory leaks, etc. The default tool diff --git a/README.md b/README.md index 9f64bad686..680faea76f 100644 --- a/README.md +++ b/README.md @@ -105,13 +105,13 @@ detailed instructions about building and installing OpenSSL. For some platforms, the installation instructions are amended by a platform specific document. - * [NOTES-ANDROID.md](NOTES-ANDROID.md) - * [NOTES-DJGPP.md](NOTES-DJGPP.md) - * [NOTES-UNIX.md](NOTES-UNIX.md) - * [NOTES-VMS.md](NOTES-VMS.md) - * [NOTES-WINDOWS.md](NOTES-WINDOWS.md) - * [NOTES-PERL.md](NOTES-PERL.md) - * [NOTES-VALGRIND.md](NOTES-VALGRIND.md) + * [Notes for UNIX-like platforms](NOTES-UNIX.md) + * [Notes for Android platforms](NOTES-ANDROID.md) + * [Notes for Windows platforms](NOTES-WINDOWS.md) + * [Notes for the DOS platform with DJGPP](NOTES-DJGPP.md) + * [Notes for the OpenVMS platform](NOTES-VMS.md) + * [Notes on Perl](NOTES-PERL.md) + * [Notes on Valgrind](NOTES-VALGRIND.md) Specific notes on upgrading to OpenSSL 3.0 from previous versions, as well as known issues are available on the [OpenSSL 3.0 Wiki] page.