Markdown version of README.txt

- Include GitHub Sponsors link/button.

- Include link to project home page (for compliance with SignPath's Code
of Conduct for Open Source projects.)

- Wordsmithing

- Remove the ACKNOWLEDGEMENTS section, which specifically mentioned
zlib, DES, and X.org.  Refer the user to the individual source files
instead.  (At this point, we include source code from a lot of projects,
not just those three.)

CMakeLists.txt

@@ -17,7 +17,7 @@ string(TOLOWER ${CMAKE_PROJECT_NAME} CMAKE_PROJECT_NAME_LC)
 set(VERSION 3.0.91)
 set(DOCVERSION 3.1)
 set(COPYRIGHT_YEAR "1999-2023")
-set(COPYRIGHT "The VirtualGL Project and many others (see README.txt)")
+set(COPYRIGHT "The VirtualGL Project and many others (see README.md)")
 set(URLTEXT "Visit http://www.TurboVNC.org for more information on TurboVNC")
 
 macro(boolean_number var)
@@ -190,7 +190,7 @@ configure_file("${CMAKE_SOURCE_DIR}/cmakescripts/cmake_uninstall.cmake.in"
 add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P cmake_uninstall.cmake)
 
 if(CMAKE_INSTALL_PREFIX STREQUAL "${CMAKE_INSTALL_DEFAULT_PREFIX}" OR WIN32)
-	install(FILES README.txt DESTINATION .)
+	install(FILES README.md DESTINATION .)
 else()
-	install(FILES README.txt DESTINATION ${CMAKE_INSTALL_DOCDIR})
+	install(FILES README.md DESTINATION ${CMAKE_INSTALL_DOCDIR})
 endif()

README.md

@@ -0,0 +1,74 @@
+About TurboVNC
+==============
+
+Virtual Network Computing (VNC) is a remote display system that allows you to
+view and interact with a desktop environment that is running on a remote
+computer.  Using VNC, you can run graphical applications on a remote machine
+and send only the pixels generated by those applications to your local machine.
+VNC is platform-independent and supports a wide variety of operating systems
+and architectures as both servers and clients.
+
+TurboVNC is a high-speed version of VNC derived from TightVNC.  It contains
+a variant of Tight encoding that is tuned to maximize performance for
+image-intensive applications (such as VirtualGL, video applications, and image
+editors) while still providing excellent performance for other types of
+applications.  TurboVNC, in combination with VirtualGL, provides a complete
+solution for remotely displaying 3D applications with interactive performance.
+
+Refer to the TurboVNC User's Guide and man pages for a more thorough
+description of the components that make up TurboVNC.
+
+More information about TurboVNC can be found at <https://TurboVNC.org>.
+
+
+Funding
+=======
+
+TurboVNC is an independent open source project, but we rely on patronage and
+funded development in order to maintain that independence.  The easiest way to
+ensure that TurboVNC remains community-focused and free of any one
+organization's agenda is to
+[sponsor our project through GitHub](https://github.com/sponsors/TurboVNC).
+All sponsorship money goes directly toward funding the labor necessary to
+maintain TurboVNC, support the user community, and implement bug fixes and
+strategically important features.
+
+[![Sponsor TurboVNC](https://img.shields.io/github/sponsors/TurboVNC?label=Sponsor&logo=GitHub)](https://github.com/sponsors/TurboVNC)
+
+
+Legal
+=====
+
+TurboVNC is
+
+    Copyright (C) 2009-2023 D. R. Commander
+    Copyright (C) 2021 Steffen Kieß
+    Copyright (C) 2011-2019 Brian P. Hinz
+    Copyright (C) 2010 University Corporation for Atmospheric Research
+    Copyright (C) 2004-2008 Sun Microsystems, Inc.
+    Copyright (C) 2004 Landmark Graphics Corporation
+
+TurboVNC contains code from LibVNCServer, RealVNC, TigerVNC, and TightVNC,
+which are
+
+    Copyright (C) 2009-2021 Pierre Ossman for Cendio AB
+    Copyright (C) 2005-2011 Martin Koegler
+    Copyright (C) 2010-2011 Joel Martin
+    Copyright (C) 2011 Gernot Tenchio
+    Copyright (C) 2010 m-privacy GmbH
+    Copyright (C) 2010 TigerVNC Team
+    Copyright (C) 2004-2009 Red Hat, Inc.
+    Copyright (C) 2009 TightVNC Team
+    Copyright (C) 2000-2006 Constantin Kaplinsky
+    Copyright (C) 2006 OCCAM Financial Technology
+    Copyright (C) 2002-2005 RealVNC Ltd.
+    Copyright (C) 2004-2005 Cendio AB
+    Copyright (C) 2003 Sun Microsystems, Inc.
+    Copyright (C) 2000 Tridia Corp.
+    Copyright (C) 1999 AT&T Laboratories Cambridge.
+
+This software is distributed under the GNU General Public Licence as published
+by the Free Software Foundation.  See the file [LICENSE.txt](LICENSE.txt) for
+the conditions under which this software is made available.  TurboVNC also
+contains code from other sources.  See the individual source files for details
+of the conditions under which they are made available.

release/installer.iss.in

@@ -51,7 +51,7 @@ Source: "@CMAKE_BINARY_DIR@\java\jre\*"; DestDir: "{app}\java\jre"; Flags: ignor
 #endif
 Source: "@CMAKE_SOURCE_DIR@\LICENSE.txt"; DestDir: "{app}"; Flags: ignoreversion
 Source: "@CMAKE_SOURCE_DIR@\ChangeLog.md"; DestDir: "{app}"; Flags: ignoreversion
-Source: "@CMAKE_SOURCE_DIR@\README.txt"; DestDir: "{app}"; Flags: ignoreversion
+Source: "@CMAKE_SOURCE_DIR@\README.md"; DestDir: "{app}"; Flags: ignoreversion
 Source: "@CMAKE_SOURCE_DIR@\win\@CMAKE_PROJECT_NAME@.url"; DestDir: "{app}"; Flags: ignoreversion
 Source: "@CMAKE_SOURCE_DIR@\doc\*.png"; DestDir: "{app}\doc"; Flags: ignoreversion; Components: doc
 Source: "@CMAKE_SOURCE_DIR@\doc\*.html"; DestDir: "{app}\doc"; Flags: ignoreversion; Components: doc
@@ -63,7 +63,7 @@ Source: "@CMAKE_SOURCE_DIR@\doc\*.css"; DestDir: "{app}\doc"; Flags: ignoreversi
 Name: "{group}\@CMAKE_PROJECT_NAME@ Viewer";                      FileName: "{app}\vncviewerw.bat";                                WorkingDir: "{app}";      Flags: "runminimized";  IconFileName: "{app}\vncviewer.ico"
 Name: "{group}\@CMAKE_PROJECT_NAME@ Viewer (Listen Mode)";        FileName: "{app}\vncviewerw.bat";  Parameters: "-listen";        WorkingDir: "{app}";      Flags: "runminimized";  IconFileName: "{app}\vncviewer.ico"
 Name: "{group}\Uninstall @CMAKE_PROJECT_NAME@";                   FileName: "{uninstallexe}";                                      WorkingDir: "{app}";
-Name: "{group}\Documentation\@CMAKE_PROJECT_NAME@ README";        FileName: "write.exe";           Parameters: "README.txt";       WorkingDir: "{app}";      Flags: "useapppaths"
+Name: "{group}\Documentation\@CMAKE_PROJECT_NAME@ README";        FileName: "write.exe";           Parameters: "README.md";       WorkingDir: "{app}";      Flags: "useapppaths"
 Name: "{group}\Documentation\@CMAKE_PROJECT_NAME@ User's Guide";  FileName: "{app}\doc\index.html";                                WorkingDir: "{app}\doc";  Components: doc;
 Name: "{group}\Documentation\Licensing Terms";                    FileName: "write.exe";           Parameters: "LICENSE.txt";      WorkingDir: "{app}\doc";  Flags: "useapppaths"
 Name: "{group}\Documentation\@CMAKE_PROJECT_NAME@ Web Site";      FileName: "{app}\@CMAKE_PROJECT_NAME@.url"

release/rpm.spec.in

@@ -274,9 +274,9 @@ fi
 %endif
 
 %if "%{prefix}" == "@CMAKE_INSTALL_DEFAULT_PREFIX@"
-  %{prefix}/README.txt
+  %{prefix}/README.md
 %else
-  %{docdir}/README.txt
+  %{docdir}/README.md
 %endif
 %if "%{viewer}" == "1"
  %{bindir}/vncviewer