Readme and changelog update, and release additions (#529)

* >> removed old ODT and DOC help file entries

>> finished updating readme files
>> added command to install readme.txt and LICENSE files

* final update of change log

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>

CMakeLists.txt

@@ -283,32 +283,6 @@ if(ORBITER_BUILD_D3D9CLIENT)
 endif()
 
 if (ORBITER_MAKE_DOC)
-	find_program(ODT_TO_PDF_COMPILER
-		NAMES soffice libreoffice
-		HINTS "C:/Program Files/LibreOffice/program"
-		REQUIRED
-	)
-
-	set(ODT_TO_PDF_FLAGS
-		"--headless --convert-to pdf --outdir <outdir> <infile>"
-		CACHE
-		STRING
-		"Compiler options for the OdtToPdfCompiler"
-	)
-
-	find_program(DOC_TO_PDF_COMPILER
-		NAMES soffice libreoffice
-		HINTS "C:/Program Files/LibreOffice/program"
-		REQUIRED
-	)
-
-	set(DOC_TO_PDF_FLAGS
-		"--headless --convert-to pdf --outdir <outdir> <infile>"
-		CACHE
-		STRING
-		"Compiler options for the DocToPdfCompiler"
-	)
-
 	find_package(Doxygen REQUIRED)
 endif()
 
@@ -354,6 +328,15 @@ INSTALL(FILES ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS}
 	COMPONENT RuntimeLibraries
 )
 
+# readme and license
+INSTALL(FILES readme.txt
+	DESTINATION ${ORBITER_INSTALL_ROOT_DIR}
+)
+INSTALL(FILES LICENSE
+	DESTINATION ${ORBITER_INSTALL_ROOT_DIR}
+)
+#COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Doc/TransX\ readme.txt ${ORBITER_BINARY_DOC_DIR}/TransX/TransX\ readme.txt
+
 # Sub-projects
 add_subdirectory(Extern)
 add_subdirectory(Src)

Doc/Orbiter User Manual/INSTALLATION.tex

@@ -15,13 +15,13 @@ \subsection{Computer requirements}
 	\hline\rule{0pt}{2ex}
 	& \textbf{Minimum requirements} & \textbf{Recommended requirements}\\
 	\hline\rule{0pt}{2ex}
-	RAM & 500MB & 2GB\\
+	RAM & 500 MB & 2 GB\\
 	\hline\rule{0pt}{2ex}
 	CPU & Dual Core &\\
 	\hline\rule{0pt}{2ex}
 	GPU & 50 GFlops & 100 GFlops\\
 	\hline\rule{0pt}{2ex}
-	Disk & 5GB of free space & 10GB of free space (80GB if you want hi-res textures)\\
+	Disk & 5 GB of free space & 10 GB of free space (80 GB if you want hi-res textures)\\
 	\hline
 	\end{longtable}
 %\end{table}

Doc/Orbiter User Manual/NEW.tex

@@ -175,5 +175,10 @@ \subsection{Bug fixes}
 $\circ$ corrected install path for mesh\\
 $\circ$ added scenario\\
 $\circ$ small mesh improvement in legs\\
+$\blacktriangleright$ Lua\\
+$\circ$ Return nil instead of bogus userdata when functions fail\\
+$\circ$ Harden vessel dereferencing\\
+$\blacktriangleright$ Replaced old MapMFD scenario parameters with current ones\\
+$\blacktriangleright$ Corrected config file and scenarios of Carina, Leonardo and SolarSail vessels\\
 $\blacktriangleright$ Converted (most of) the scattered documentation into LaTex format and organized it into 3 pdf files: "Orbiter User Manual", "Orbiter Developer Manual" and "Orbiter Technical Reference".\\
 \end{document}

README.md

@@ -26,10 +26,10 @@ D3D9Client graphics engine is licensed under LGPL, see [LGPL](./OVP/D3D9Client/L
 Hardware requirements needed by Orbiter:
 |  | Minimum requirements | Recommended requirements |
 | ---- | ---- | ---- |
-| RAM: | 500MB | 2GB |
+| RAM: | 500 MB | 2 GB |
 | CPU: | Dual Core |  |
 | GPU: | 50 GFlops | 100 GFlops |
-| Disk: | 5GB of free space | 10GB of free space (80GB if you want hi-res textures) |
+| Disk: | 5 GB of free space | 10 GB of free space (80 GB if you want hi-res textures) |
 
 Get the Orbiter source repository from github
 ```bash
@@ -84,22 +84,22 @@ See [README.compile](./README.compile) for details on building Orbiter.
 The Orbiter git repository does not include most of the planetary texture files
 required for running Orbiter.
 You need to install those separately. The easiest way to do so is by installing
-[Orbiter 2016](http://orbit.medphys.ucl.ac.uk/download.html). Optionally you can
-also install high-resolution versions of the textures from the Orbiter website.
-You should keep the Orbiter 2016 installation separate from your Orbiter git
+an [Orbiter](https://github.com/orbitersim/orbiter/releases) release. Optionally
+you can also install high-resolution versions of the textures from the Orbiter website.
+You should keep the Orbiter installation separate from your Orbiter git
 repository.
 
-To configure Orbiter to use the 2016 texture installation, set the
-ORBITER_PLANET_TEXTURE_INSTALL_DIR entry in CMake. For example, if Orbiter 2016
-was installed in `C:\Orbiter2016`, the CMake option should be set to
-`C:/Orbiter2016/Textures`.
+To configure Orbiter to use the texture installation, set the
+ORBITER_PLANET_TEXTURE_INSTALL_DIR entry in CMake. For example, if Orbiter
+was installed in `C:\Orbiter`, the CMake option should be set to
+`C:/Orbiter/Textures`.
 Alternatively, you can configure the texture directory after building Orbiter
 by setting the `PlanetTexDir` entry in `Orbiter.cfg`.
 
 ## Help
 
-Help files are located in the Doc subfolder (if you built them). Orbiter.pdf is the
-main Orbiter user manual.
+Help files are located in the Doc subfolder (if you built them).
+Orbiter User Manual.pdf is the main Orbiter user manual.
 
 The in-game help system can be opened via the "Help" button on
 the Orbiter Launchpad dialog, or with Alt-F1 while running

readme.txt

@@ -1,8 +1,27 @@
 Orbiter 2024 Readme
 ===================
 
-1. Orbiter instalation
-----------------------
+
+Orbiter is now published as an Open Source project under the MIT
+License (see LICENSE file for details).
+
+
+1. Hardware requirements
+------------------------
+The minimum hardware requirements needed by Orbiter are:
+RAM: 500 MB
+CPU: Dual Core
+GPU: 50 GFlops
+Disk: 5 GB of free space
+
+The recommended hardware requirements are:
+RAM: 2 GB
+GPU: 100 GFlops
+Disk: 10 GB of free space (80 GB if you want hi-res textures)
+
+
+2. Orbiter installation
+-----------------------
 Create a new folder for the Orbiter installation, e.g. C:\Orbiter
 or \%HOMEPATH\%\Orbiter. Note that creating an Orbiter folder in
 Program files or Program files (x86) is not recommended, because
@@ -31,29 +50,6 @@ all contents and subdirectories. This will completely remove
 Orbiter from your hard drive.
 
 
-2. Runtime libraries
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> TODO
---------------------
-Note: Orbiter requires the VC2008 runtime libraries installed
-on the computer. On most systems, these libraries will already
-be installed.
-The zip file package does not
-install these libraries by default. If Orbiter fails to launch
-with an error message similar to
-
-"It wasn't possible to start this application because the
-configuration of the application is incorrect. The reinstallation
-of the application might correct this problem."
-
-then the runtime libraries may be missing. You can install them
-by executing the vcredist_x86.exe installer package in the Install
-folder, or by downloading from the Microsoft web site.
-
-Note that some 3rd party Orbiter addons may require additional
-runtime versions. Refer to the installation instructions of the
-addon.
-
-
 3. Launching Orbiter
 --------------------
 The Orbiter simulator can be launched either with a built-in
@@ -81,4 +77,4 @@ the Orbiter Launchpad dialog, or with Alt-F1 while running
 Orbiter.
 
 Remaining questions can be posted on the Orbiter user forum at
-https://orbiter-forum.com.
+https://orbiter-forum.com.