From 913a853c33b8272f11ab7c0ab87ae625544d5b37 Mon Sep 17 00:00:00 2001
From: ConfuSomu
Date: Sat, 25 Nov 2023 21:54:25 -0500
Subject: Update readme

It has become woefully out of date. I also took the time to add a
description about what the app actually does.
---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3cae597..390e1cc 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,30 @@
+# ActorViewer
+
+ActorViewer is a tool that allows one to explore their Fediverse data exports. It uses the Qt 5 library for its user interface. Currently, ActorViewer allows doing the following:
+
+* Open Mastodon data exports (make sure to have them decompressed and open the outbox.json file!)
+  * Support for other Fediverse platforms will be added in the future, in addition to presenting a smarter UI for opening exports. Also, automatic decompression of downloaded exports would be handy.
+* Filter through types of posts: public, unlisted, private, boosts…
+* Search through your posts with a fun scroll bar to navigate through search results
+* View embedded media and polls in posts
+* View all information about the activities in the Mastodon outbox.json ActivityStream
+* 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.
+
 ## Building
 
-To build, please have CMake and the Qt library installed. Then use:
+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:
 
 ```
 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. If you, make sure to set the `LD_PRELOAD` environment variable in a similar manner:
+
+```
+LD_PRELOAD=~/autumn/Devel/mastodonpp/build/src/libmastodonpp.so.0 ./build/ActorViewer
+```
-- 
cgit v1.2.3-54-g00ecf