From 64a4c4e1688d91461d3276f2198e561a716b2e84 Mon Sep 17 00:00:00 2001 From: Guilherme Silva <626206+guihkx@users.noreply.github.com> Date: Wed, 26 Oct 2022 07:53:54 -0300 Subject: [PATCH] Docs: Fix broken link and add a quick build example (#827) * chore(gitignore): ignore `build-dir` * chore(docs): fix broken link and add a build example Co-authored-by: guihkx --- .gitignore | 5 ++++- resources/docs/Documentation.md | 15 ++++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index c630ebfa2..645ab7f48 100644 --- a/.gitignore +++ b/.gitignore @@ -25,4 +25,7 @@ *.user* localization/*qm *.TMP -resources/skins/*/*.map \ No newline at end of file +resources/skins/*/*.map + +# Build directory. +build-dir/ \ No newline at end of file diff --git a/resources/docs/Documentation.md b/resources/docs/Documentation.md index fb0bb2ef4..1fcc20031 100644 --- a/resources/docs/Documentation.md +++ b/resources/docs/Documentation.md @@ -569,7 +569,20 @@ So in order to comfortably add feed directly to RSS Guard from you browser witho You can support author of RSS Guard via [donations](https://github.com/sponsors/martinrotter). ### Compiling RSS Guard -RSS Guard is C++ application and all common build instructions can be found in top of [project file](https://github.com/martinrotter/rssguard/blob/master/build.pro). +RSS Guard is a C++ application and all common build instructions can be found at the top of [CMakeLists.txt](https://github.com/martinrotter/rssguard/blob/master/CMakeLists.txt). Here's a quick example of how to build on Linux: + +```bash +# Create a build directory. +mkdir build-dir +# Configure the project to build using Qt 6, and disable built-in web browser support. +cmake -B build-dir -S . -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_WITH_QT6=ON -DUSE_WEBENGINE=OFF +# Compile it, in parallel mode. +cmake --build build-dir -j$(nproc) +# (Optional) Run the build to test it. +./build-dir/src/rssguard/rssguard +# (Optional) Install RSS Guard system-wide. +sudo make -C build-dir install +``` ### Plugin API RSS Guard offers simple C++ API for creating new service plugins. All base API classes are in folder [`abstract`](https://github.com/martinrotter/rssguard/tree/master/src/librssguard/services/abstract). User must subclass and implement all interface classes: