This repository has been archived on 2020-04-18. You can view files and clone it, but cannot push or open issues or pull requests.
FediPotato/README.adoc

4.3 KiB

FediPotato

FediPotato is a client for Fediverse servers.

Planned features

  • ❏ Get posts from:

    • ❏ Mastodon & Pleroma

    • ❏ Parastat

    • ❏ Maybe others

  • ❏ Show posts in a threaded view.

  • ❏ Subscribing to hashtags.

  • ❏ Separate filtered views (timelines filtered with regular expressions).

  • ❏ Post posts.

Install

From source

Dependencies

  • Tested OS: Linux

  • C++ compiler with C++17 support (tested: GCC 7/8/9, clang 6/7)

  • CMake (at least: 3.9)

  • mastodonpp (at least: 0.5.4)

  • nlohmann-json (tested: 3.6)

  • Boost (at least: 1.62)

  • Qt (tested: 5.13)

  • Optional

    • Library documentation: Doxygen (tested: 1.8)

    • Tests: Catch (tested: 2.5 / 1.2)

    • DEB package: dpkg (tested: 1.19)

    • RPM package: rpm-build (tested: 4.11)

Get sourcecode

Development version
git clone https://schlomp.space/FediPotato/FediPotato.git

Compile

mkdir -p build && cd build
cmake ..
cmake --build . -- -j$(nproc --ignore=1)
CMake options:
  • -DCMAKE_BUILD_TYPE=Debug for a debug build.

  • -DWITH_TESTS=YES if you want to compile the tests.

  • -DWITH_GUI=NO to only compile and install the library.

  • -DWITH_CLANG-TIDY=YES to check the sourcecode with clang-tidy while compiling.

  • -WITH_DOC=YES to generate the API documentation.

  • One of:

    • -DWITH_DEB=YES if you want to be able to generate a deb-package.

    • -DWITH_RPM=YES if you want to be able to generate an rpm-package.

To create a deb or rpm package, run make package after compiling.