FediPotato
/
FediPotato
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme and un-comment install instructions.

This commit is contained in:
tastytea 2020-02-25 03:26:50 +01:00
parent a6d0cb84cf
commit f1abf4071e
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 36 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.adoc
View File

@ -16,12 +16,13 @@
:uri-dpkg: https://packages.qa.debian.org/dpkg
:uri-rpm-build: http://www.rpm.org
:uri-clang-tidy: https://clang.llvm.org/extra/clang-tidy/
:uri-qt-install: https://doc.qt.io/qt-5/gettingstarted.html
*{project}* is a client for link:{uri-wp-fediverse}[Fediverse] servers.
// It currently supports link:{uri-wp-mastodon}[Mastodon] and
// link:{uri-pleroma}[Pleroma].
// == Install
== Install
// === Gentoo
@ -54,52 +55,53 @@
// yum install ./fedipotato*.rpm
// --------------------------------------------------------------------------------
// === From source
=== From source
// ==== Dependencies
==== Dependencies
// * Tested OS: Linux
// * C\++ compiler with C++17 support (tested: link:{uri-gcc}[GCC] 7/8/9,
// link:{uri-clang}[clang] 6/7)
// * link:{uri-cmake}[CMake] (at least: 3.9)
// * link:{uri-mastodonpp}[mastodonpp] (at least: 0.5)
// * Optional
// ** Library documentation: link:{uri-doxygen}[Doxygen] (tested: 1.8)
// ** Tests: link:{uri-catch}[Catch] (tested: 2.5 / 1.2)
// ** DEB package: link:{uri-dpkg}[dpkg] (tested: 1.19)
// ** RPM package: link:{uri-rpm-build}[rpm-build] (tested: 4.11)
* Tested OS: Linux
* C\++ compiler with C++17 support (tested: link:{uri-gcc}[GCC] 7/8/9,
link:{uri-clang}[clang] 6/7)
* link:{uri-cmake}[CMake] (at least: 3.9)
* link:{uri-mastodonpp}[mastodonpp] (at least: 0.5)
* link:{uri-qt-install}[Qt] with QtQuick (at least: 5.10)
* Optional
** Library documentation: link:{uri-doxygen}[Doxygen] (tested: 1.8)
** Tests: link:{uri-catch}[Catch] (tested: 2.5 / 1.2)
** DEB package: link:{uri-dpkg}[dpkg] (tested: 1.19)
** RPM package: link:{uri-rpm-build}[rpm-build] (tested: 4.11)
// ==== Get sourcecode
==== Get sourcecode
// ===== Release
// Download the current release at link:{uri-base}/releases[schlomp.space].
// ===== Development version
===== Development version
// [source,shell]
// --------------------------------------------------------------------------------
// git clone https://schlomp.space/tastytea/FediPotato.git
// --------------------------------------------------------------------------------
[source,shell]
--------------------------------------------------------------------------------
git clone https://schlomp.space/tastytea/FediPotato.git
--------------------------------------------------------------------------------
// ==== Compile
==== Compile
// [source,shell]
// --------------------------------------------------------------------------------
// mkdir -p build && cd build
// cmake ..
// cmake --build . -- -j$(nproc --ignore=1)
// --------------------------------------------------------------------------------
[source,shell]
--------------------------------------------------------------------------------
mkdir -p build && cd build
cmake ..
cmake --build . -- -j$(nproc --ignore=1)
--------------------------------------------------------------------------------
// .CMake options:
// * `-DCMAKE_BUILD_TYPE=Debug` for a debug build.
.CMake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build.
// * `-DWITH_TESTS=YES` if you want to compile the tests.
// * `-DWITH_CLANG-TIDY=YES` to check the sourcecode with
// link:{uri-clang-tidy}[clang-tidy] while compiling.
// * 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.
* `-DWITH_CLANG-TIDY=YES` to check the sourcecode with
link:{uri-clang-tidy}[clang-tidy] while compiling.
* 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.
To create a deb or rpm package, run `make package` after compiling.
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]