diff --git a/compiling.txt b/COMPILING.md similarity index 87% rename from compiling.txt rename to COMPILING.md index 55c9b242..8aa1c561 100644 --- a/compiling.txt +++ b/COMPILING.md @@ -17,5 +17,5 @@ the client libraries as symbol information will be included. Use cmake to compile on Windows or Mac. If you have any questions, problems or suggestions (particularly related to -installing on a more unusual device like a plug-computer) then please get in -touch using the details in readme.txt. +installing on a more unusual device) then please get in touch using the details +in README.md. diff --git a/Makefile b/Makefile index 419aaa2e..ae69e05b 100644 --- a/Makefile +++ b/Makefile @@ -38,8 +38,10 @@ DISTFILES= \ notice.html \ pskfile.example \ pwfile.example \ - readme-windows.txt \ - readme.md + README-compiling \ + README-letsencrypt \ + README-windows.md \ + README.md .PHONY : all mosquitto api docs binary check clean reallyclean test install uninstall dist sign copy localdocker diff --git a/readme-tests.md b/README-tests.md similarity index 100% rename from readme-tests.md rename to README-tests.md diff --git a/readme-windows.txt b/README-windows.txt similarity index 100% rename from readme-windows.txt rename to README-windows.txt diff --git a/readme.md b/README.md similarity index 98% rename from readme.md rename to README.md index eb2c2720..1ed99f60 100644 --- a/readme.md +++ b/README.md @@ -58,7 +58,7 @@ To build from source the recommended route for end users is to download the archive from . On Windows and Mac, use `cmake` to build. On other platforms, just run `make` -to build. For Windows, see also `readme-windows.txt`. +to build. For Windows, see also `README-windows.md`. If you are building from the git repository then the documentation will not already be built. Use `make binary` to skip building the man pages, or install diff --git a/installer/mosquitto.nsi b/installer/mosquitto.nsi index 637a1750..224279f8 100644 --- a/installer/mosquitto.nsi +++ b/installer/mosquitto.nsi @@ -52,8 +52,9 @@ Section "Files" SecInstall File "..\ChangeLog.txt" File "..\mosquitto.conf" File "..\pwfile.example" - File "..\readme.md" - File "..\readme-windows.txt" + File "..\README.md" + File "..\README-windows.txt" + File "..\README-letsencrypt.txt" ;File "C:\pthreads\Pre-built.2\dll\x86\pthreadVC2.dll" File "C:\OpenSSL-Win32\bin\libssl-1_1.dll" File "C:\OpenSSL-Win32\bin\libcrypto-1_1.dll" @@ -100,8 +101,9 @@ Section "Uninstall" Delete "$INSTDIR\ChangeLog.txt" Delete "$INSTDIR\mosquitto.conf" Delete "$INSTDIR\pwfile.example" - Delete "$INSTDIR\readme.txt" - Delete "$INSTDIR\readme-windows.txt" + Delete "$INSTDIR\README.txt" + Delete "$INSTDIR\README-windows.txt" + Delete "$INSTDIR\README-letsencrypt.txt" ;Delete "$INSTDIR\pthreadVC2.dll" Delete "$INSTDIR\libssl-1_1.dll" Delete "$INSTDIR\libcrypto-1_1.dll" diff --git a/installer/mosquitto64.nsi b/installer/mosquitto64.nsi index 54db496b..dd45d0e5 100644 --- a/installer/mosquitto64.nsi +++ b/installer/mosquitto64.nsi @@ -53,8 +53,9 @@ Section "Files" SecInstall File "..\ChangeLog.txt" File "..\mosquitto.conf" File "..\pwfile.example" - File "..\readme.md" - File "..\readme-windows.txt" + File "..\README.md" + File "..\README-windows.txt" + File "..\README-letsencrypt.txt" ;File "C:\pthreads\Pre-built.2\dll\x64\pthreadVC2.dll" File "C:\OpenSSL-Win64\bin\libssl-1_1-x64.dll" File "C:\OpenSSL-Win64\bin\libcrypto-1_1-x64.dll" @@ -101,8 +102,9 @@ Section "Uninstall" Delete "$INSTDIR\ChangeLog.txt" Delete "$INSTDIR\mosquitto.conf" Delete "$INSTDIR\pwfile.example" - Delete "$INSTDIR\readme.txt" - Delete "$INSTDIR\readme-windows.txt" + Delete "$INSTDIR\README.txt" + Delete "$INSTDIR\README-windows.txt" + Delete "$INSTDIR\README-letsencrypt.txt" ;Delete "$INSTDIR\pthreadVC2.dll" Delete "$INSTDIR\libssl-1_1-x64.dll" Delete "$INSTDIR\libcrypto-1_1-x64.dll" diff --git a/www/pages/download.md b/www/pages/download.md index 4619a7b4..516ad0e8 100644 --- a/www/pages/download.md +++ b/www/pages/download.md @@ -27,7 +27,7 @@ distributions. * [mosquitto-1.6.12-install-windows-x64.exe](https://mosquitto.org/files/binary/win64/mosquitto-1.6.12-install-windows-x64.exe) (~1.4 MB) (64-bit build, Windows Vista and up, built with Visual Studio Community 2019) * [mosquitto-1.6.12-install-windows-x32.exe](https://mosquitto.org/files/binary/win32/mosquitto-1.6.12-install-windows-x86.exe) (~1.4 MB) (32-bit build, Windows Vista and up, built with Visual Studio Community 2019) -See also readme-windows.txt after installing. +See also README-windows.md after installing. ## Mac Mosquitto can be installed from the homebrew project. See