From ad481bbbc07c0edadd433a2f4dccb8e2bf52573b Mon Sep 17 00:00:00 2001 From: defnax Date: Wed, 17 Sep 2025 21:43:51 +0200 Subject: [PATCH] Fix & improve guide --- README.md | 4 ++- .../Debian+Ubuntu/Linux_InstallGuide.md | 31 +++++++++---------- .../Linux_RedHat_InstallGuide.md | 15 ++++----- 3 files changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ccbfb54f8..217121af3 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,9 @@ in the aim of creating packages for the supported platforms (and more) in the [build_scripts](https://github.com/RetroShare/RetroShare/tree/master/build_scripts) directory of this repository. ## Compilation on Windows -Follow this file : [WindowsMSys2_InstallGuide.md](https://github.com/RetroShare/RetroShare/blob/master/build_scripts/Windows-msys2/WindowsMSys2_InstallGuide.md) +Follow this file : [WindowsMSys2_InstallGuide](https://github.com/RetroShare/RetroShare/blob/master/build_scripts/Windows-msys2/WindowsMSys2_InstallGuide.md) + +With QtCreator : [Windows-QtCreator-InstallGuide](https://github.com/RetroShare/RetroShare/blob/master/build_scripts/Windows/Windows-QtCreator-InstallGuide.md) ## Compilation on MacOSX diff --git a/build_scripts/Debian+Ubuntu/Linux_InstallGuide.md b/build_scripts/Debian+Ubuntu/Linux_InstallGuide.md index 873c34d21..b1591d9e9 100644 --- a/build_scripts/Debian+Ubuntu/Linux_InstallGuide.md +++ b/build_scripts/Debian+Ubuntu/Linux_InstallGuide.md @@ -3,15 +3,15 @@ ### Install package dependencies: -#### Debian/Ubuntu +#### Debian / Ubuntu / Linux Mint ```bash - sudo apt-get install g++ cmake libbz2-dev libjson-c-dev libssl-dev libsqlcipher-dev \ - libupnp-dev libxss-dev rapidjson-dev libbotan-2-dev libasio-dev + sudo apt-get install git g++ cmake libbz2-dev libjson-c-dev libssl-dev libsqlcipher-dev \ + libupnp-dev doxygen libxss-dev rapidjson-dev libbotan-2-dev libasio-dev ``` To compile with Qt5: ```bash - sudo apt-get install qt5-qmake qtmultimedia5-dev qt6-5compat-dev libqt5x11extras5-dev + sudo apt-get install qt5-qmake qtmultimedia5-dev libqt5x11extras5-dev ``` To compile with Qt6: @@ -54,17 +54,15 @@ Additional dependencies for plugins: libxslt-devel speex-devel speexdsp-devel ``` -#### Linux Mint +#### Arch Linux / Manjaro / EndeavourOS ```bash - sudo apt-get install git g++ cmake qt5-qmake qtmultimedia5-dev \ - libqt5x11extras5-dev libupnp-dev libxss-dev libssl-dev libsqlcipher-dev \ - rapidjson-dev doxygen libbz2-dev libjson-c-dev libbotan-2-dev libasio-dev + sudo pacman -S base-devel libgnome-keyring cmake qt5-tools qt5-multimedia qt5-x11extras \ + rapidjson doxygen libupnp libxslt libxss sqlcipher botan2 bzip2 json-c ``` -#### Arch Linux +To compile with Qt6: ```bash - pacman -S base-devel libgnome-keyring cmake qt5-tools qt5-multimedia qt5-x11extras \ - rapidjson libupnp libxslt libxss sqlcipher botan2 bzip2 json-c + sudo pacman -S qt6-base qt6-multimedia qt6-5compat ``` ### Checkout the source code @@ -88,7 +86,7 @@ Additional dependencies for plugins: The executable produced will be: ```bash - ./retroshare-gui/src/retroshare + ./retroshare-gui/src/retroshare ``` ### Install @@ -98,7 +96,7 @@ The executable produced will be: The executable produced will be: ```bash - ~/usr/bin/RetroShare + ~/usr/bin/RetroShare ``` ### For packagers @@ -135,6 +133,8 @@ You need to place sqlcipher so that the hierarchy is: ### Build infos +Note: If you installed Qt6 you need to use `qmake6` on the command line. + For the `FeedReader` it is required to append the config option `CONFIG+=retroshare_plugins`. Make sure `plugins/plugins.pro` contains `FeedReader` in the list of plugins to compile. @@ -162,10 +162,9 @@ For `Autologin` it is required to append the config option `CONFIG+=rs_autologin * rs_deep_files_index: build with deep file indexing support * "CONFIG+=..." enable other extra compile time features, you can find the almost complete list in file *<sourcefolder>\retroshare.pri* -Example: +### Examples: ```batch -qmake CONFIG-=debug CONFIG+=release CONFIG+=rs_use_native_dialog CONFIG+=rs_gui_cmark +qmake CONFIG+=debug CONFIG+=release CONFIG+=rs_use_native_dialog CONFIG+=rs_gui_cmark qmake CONFIG+=rs_jsonapi CONFIG+=rs_webui CONFIG+=rs_autologin -qmake CONFIG+=rs_deep_channels_index CONFIG += gxsthewire CONFIG += wikipoos ``` \ No newline at end of file diff --git a/build_scripts/RedHat+Fedora/Linux_RedHat_InstallGuide.md b/build_scripts/RedHat+Fedora/Linux_RedHat_InstallGuide.md index 757b94a2f..12c365804 100644 --- a/build_scripts/RedHat+Fedora/Linux_RedHat_InstallGuide.md +++ b/build_scripts/RedHat+Fedora/Linux_RedHat_InstallGuide.md @@ -5,9 +5,9 @@ ### Install package dependencies: #### RedHat/Fedora ```bash - sudo dnf install mesa-libGL-devel gcc cmake rapidjson-devel \ - libupnp openssl sqlcipher sqlcipher-devel \ - botan2 botan2-devel json-c-devel bzip2-devel asio-devel libsecret libXScrnSaver-devel + sudo dnf install mesa-libGL-devel gcc cmake rapidjson-devel \ + libupnp openssl sqlcipher sqlcipher-devel \ + botan2 botan2-devel json-c-devel bzip2-devel asio-devel libsecret libXScrnSaver-devel ``` To compile with Qt5: @@ -46,7 +46,7 @@ Additional dependencies for Feedreader plugin: The executable produced will be: ```bash - ./retroshare-gui/src/retroshare + ./retroshare-gui/src/retroshare ``` ### Install @@ -56,7 +56,7 @@ The executable produced will be: The executable produced will be: ```bash - ~/usr/bin/RetroShare + ~/usr/bin/RetroShare ``` ### For packagers @@ -92,6 +92,8 @@ You need to place sqlcipher so that the hierarchy is: ### Build infos +Note: If you installed Qt6 you need to use `qmake6` on the command line. + For the `FeedReader` it is required to append the config option `CONFIG+=retroshare_plugins`. Make sure `plugins/plugins.pro` contains `FeedReader` in the list of plugins to compile. @@ -122,7 +124,6 @@ For `Autologin` it is required to append the config option `CONFIG+=rs_autologin Example: ```batch -qmake CONFIG-=debug CONFIG+=release CONFIG+=rs_use_native_dialog CONFIG+=rs_gui_cmark +qmake CONFIG+=debug CONFIG+=release CONFIG+=rs_use_native_dialog CONFIG+=rs_gui_cmark qmake CONFIG+=rs_jsonapi CONFIG+=rs_webui CONFIG+=rs_autologin -qmake CONFIG+=rs_deep_channels_index CONFIG += gxsthewire CONFIG += wikipoos ``` \ No newline at end of file