Document minimum library versions

eggheads · Jul 9, 2024 · d2160ec · d2160ec
1 parent 2cb8864
commit d2160ec
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/doc/sphinx_source/install/readme.rst b/doc/sphinx_source/install/readme.rst
@@ -98,7 +98,25 @@ System Pre-Requisites
 
   Before you can compile Eggdrop, Tcl must be installed on your system. Many systems have Tcl installed on them by default (you can check by trying the command "tclsh"; if you are given a '%' for a prompt, it is, and you can type 'exit' to exit the Tcl shell. However, Eggdrop also requires the Tcl development header files to be installed. They can often be installed via an OS package manager, usually called something similar to 'tcl-dev' for the package name. You can also download Tcl source from `<https://www.tcl.tk/software/tcltk/download.html>`_. 
 
-  It is also strongly recommended to install openssl (and its development headers) in order to enable SSL/TLS protection of network data. The header files are often called something similar to 'libssl-dev'. 
+  Eggdrop also requires openssl (and its development headers) in order to enable SSL/TLS protection of network data. The header files are often called something similar to 'libssl-dev'. While not advised, this requirement can be removed by compilling using ``./configure --disable-tls``, but you will not be able to connect to TLS-protected IRC servers nor utilize secure botnet communication.
+
+Minimum Requirements
+--------------------
+
+Some components of Eggdrop relies on a variety of third-party libraries, documented here.
+
++-------------------------------+-------------------+-------------------+
+| Functionality                 | Package           | Minimum Version   |
++===============================+===================+===================+
+| Tcl interpreter (required)    | Tcl Dev Library   | 8.6.0             |
++-------------------------------+-------------------+-------------------+
+| Secure communication          | OpenSSL           | X.X.X             |
++-------------------------------+-------------------+-------------------+
+| Python module                 | Python            | 3.8.0             |
++-------------------------------+-------------------+-------------------+
+| Compression module            | zlib              | Any               |
++-------------------------------+-------------------+-------------------+
+
 
 Quick Startup
 -------------