Client for Fediverse servers.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tastytea 6948c12b9e
Add PROJECT_HOMEPAGE_URL to CMake recipe.
2 months ago
cmake Add dependencies to CMake config. 4 months ago
gui Add accessible names and tooltips to WidgetPost. 4 months ago
lib [WIP] Add Mastodon threads. 2 months ago
tests Add first test. 4 months ago
.clang-tidy Update .clang-tidy. 4 months ago
.editorconfig Initial commit. 4 months ago
.gitignore Initial commit. 4 months ago
AUTHORS Add AUTHORS. 4 months ago
CMakeLists.txt Add PROJECT_HOMEPAGE_URL to CMake recipe. 2 months ago
CODE_OF_CONDUCT.adoc Initial commit. 4 months ago
CONTRIBUTING.adoc Fix repository URI in documentation. 2 months ago
CREDITS Typo. 4 months ago
LICENSE Initial commit. 4 months ago
README.adoc [WIP] Add Mastodon threads. 2 months ago

README.adoc

FediPotato

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.

How to contribute

Read the Code of Conduct.

Reporting bugs or suggesting enhancements

Before reporting a bug, please perform a search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one. Same for enhancements.

You can also contact me via E-Mail, XMPP or the Fediverse if you don’t want to open an account.

Pull requests

Please use similar coding conventions as the rest of the project. The basic rule to remember is to write code in the same style as the existing/surrounding code.

Add a copyright line with the year, your name and your email address to the files you edited. Add your name and email to AUTHORS. Unless you don’t want to.

You can also send me your patches via E-Mail, ideally using git format-patch or git send-email.