pogmommy/rssguard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: Fix broken link and add a quick build example (#827)

Browse source 
* chore(gitignore): ignore `build-dir`

* chore(docs): fix broken link and add a build example

Co-authored-by: guihkx <guihkx@users.noreply.github.com>
This commit is contained in:
Guilherme Silva 2022-10-26 07:53:54 -03:00 • committed by GitHub
parent 2110bdf88a
commit 64a4c4e168
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.gitignore vendored
View file

@ -25,4 +25,7 @@
*.user*
localization/*qm
*.TMP
resources/skins/*/*.map
resources/skins/*/*.map
# Build directory.
build-dir/

15
resources/docs/Documentation.md
View file

@ -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).
### <a id="compil"></a>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
```
### <a id="papi"></a>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: