diff options
| author | ConfuSomu | 2024-05-11 19:57:44 -0400 |
|---|---|---|
| committer | ConfuSomu | 2024-05-11 19:57:44 -0400 |
| commit | 39a2aa5b99ffd2ee702236a696768efc4b9fa070 (patch) | |
| tree | d7e573f94322638d8f17703bc0adcb38b778a7ee /README.md | |
| parent | 00088f7b552266f08b643c8593c3bcde78d2a5c2 (diff) | |
| download | ActorViewer-39a2aa5b99ffd2ee702236a696768efc4b9fa070.tar ActorViewer-39a2aa5b99ffd2ee702236a696768efc4b9fa070.tar.gz ActorViewer-39a2aa5b99ffd2ee702236a696768efc4b9fa070.zip | |
Update readme
The building method changed since mastodonpp is now a git submodule and
CMakeLists.txt has been updated to build everything seamlessly. Thus,
update the README.md with the new instructions.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 8 insertions, 12 deletions
@@ -11,23 +11,19 @@ ActorViewer is a tool that allows one to explore their Fediverse data exports. I * Go to a random status! * Copy the status text -Furthermore, support for viewing replies to your posts will be added. I also want the app to have translation support before making a release. +Furthermore, support for viewing replies to your posts will be added. I also want the app to have translation support (and be translated) before making a release. ## Building -To build, please have CMake and the Qt library installed. You will also need [mastodonpp](https://schlomp.space/tastytea/mastodonpp/) installed in your environment and findable by CMake. Then use: +To build, please have CMake and the Qt library installed. You will also need [mastodonpp](https://schlomp.space/tastytea/mastodonpp/), which can be retrieved by initializing git submodules. -``` -git clone https://git.twilightsparkle.space/ActorViewer && cd ActorViewer -cmake -B build -DCMAKE_BUILD_TYPE=Debug # Initially -cmake --build build -j$(nproc --all) --target all # All; after modifying ui files -cmake --build build -j$(nproc --all) --target clean # To clean -``` - -When running, you might get an error about a shared object due to mastodonpp not being in the linker's path. If you do, make sure to set the `LD_PRELOAD` environment variable in the following manner: +Simply said, after install CMake and Qt from your package manager, do the following to build the project: ``` -LD_PRELOAD=~/Devel/mastodonpp/build/src/libmastodonpp.so.0 ./build/ActorViewer +git clone --recurse-submodules https://git.twilightsparkle.space/ActorViewer && cd ActorViewer +cmake -B build -DCMAKE_BUILD_TYPE=Debug # Initially and if CMakeLists.txt changes +cmake --build build -j$(nproc --all) --target all # To build +cmake --build build -j$(nproc --all) --target clean # To clean ``` -In the future, I plan to address both problems by making a Flatpak and by extending my CMakeLists.txt to also build mastodonpp and any other required dependencies. +I plan to make a Flatpak in the near future so that manually building will not be necessary. |