docs: [#319] add system dependencies

josecelano · josecelano · commit c65f039e0dcf · 2023-05-02T09:49:29.000+01:00
diff --git a/cSpell.json b/cSpell.json
@@ -39,6 +39,7 @@
         "lcov",
         "leecher",
         "leechers",
+        "libsqlite",
         "libtorrent",
         "Lphant",
         "metainfo",
diff --git a/src/lib.rs b/src/lib.rs
@@ -68,6 +68,26 @@
 //!
 //! ## Prerequisites
 //!
+//! The tracker has some system dependencies:
+//!
+//! Since we are using the `openssl` crate with the [vendored feature](https://docs.rs/openssl/latest/openssl/#vendored),
+//! enabled, you will need to install the following dependencies:
+//!
+//! ```text
+//! sudo apt-get install pkg-config libssl-dev make
+//! ```
+//!
+//! If you are using `SQLite3` as database driver, you will need to install the
+//! following dependency:
+//!
+//! ```text
+//! sudo apt-get install libsqlite3-dev
+//! ```
+//!
+//! > **NOTICE**: those are the commands for `Ubuntu`. If you are using a
+//! different OS, you will need to install the equivalent packages. Please
+//! refer to the documentation of your OS.
+//!
 //! With the default configuration you will need to create the `storage` directory:
 //!
 //! ```text
