Final documentation updates for initial 0.1.0 beta version

CHANGELOG.md

@@ -1 +1,26 @@
-#Relatica Change Log
+# Relatica Change Log
+
+## Version 0.1.0 (beta)
+* Initial public release, as an early beta.
+* Major working features (at least in initial implementation versions):
+  * Logging in with username/password. These are stored using the OS specific key vaults
+  * Writing posts
+      * Typing @ brings up a list of all known fediverse accounts that the app has ever seen as you type (but not all that your server has seen)
+      * Typing # brings up a list of all known hashtags that the app has ever seen as you type (but not all that your server has seen)
+      * Very basic markdown (wrapping in stars for bold/italics)
+      * Adding new images to posts
+        * Image posting with easy means of adding ALT text
+      * Attaching existing images to posts
+  * Resharing posts
+  * Browsing timelines including from groups you've created. In this app "Home" is the same as the "Network" (grid) button in Frio and "Yours" is the equivalent of the Home button in the app.
+  * Browsing notifications and marking individual ones read or all read
+  * Getting gallery list and browsing galleries
+  * Browsing your contacts or searching contacts that are known by your app
+  * Adjudicating follow requests
+  * Going to individual profiles to see their posts, follow/unfollow, add/remove from groups
+  * A "low bandwidth" mode that defers loading of images until you click on them, unless the app already has that image cached locally.
+  * Light/dark mode selection
+  * Opening posts, comments, and profiles in the "external" browser
+  * Playing videos within the app on iOS and Android.
+  * Pulling down to refresh timelines, galleries, and posts but loading newer or older posts has specific buttons (this will probably change in the near future)
+  * Pulling down to refresh notifications and contacts gets updates to that respective data (this may change in the near future)

README.md

@@ -13,7 +13,10 @@ A Flutter application for interfacing with the Friendica social network.
 
 ## Current Status
 
-The project is currently in an early-beta state. If you'd like to use it at this time please see the notes at [Redica Beta Testing Program](beta-program.md).
+The project is currently in an early-beta state. If you'd like to use it at this time please 
+see the notes at [Relatica Beta Testing Program](beta-program.md). 
+
+It is possible to install it now by following the [install instructions](install.md).
 
 If you would like to contribute please see [this Developers Notes](developers.md) section.
 

beta-program.md

@@ -22,8 +22,8 @@ January 2023. However, usable doesn't mean feature complete, even for the
 subset of features I want to implement. Usable also doesn't mean bug free
 experience. It can still be useful to people which is why I'm opening up
 access to it right now. Having said that, this is an early beta program. 
-Since not everyone readig this that is considering using the app at this stage
-may be familiar with that aspect of the software development process I 
+Since not everyone that is considering using the software at this point may
+be familiar with that aspect of the software development process I 
 wanted to lay out some expectations before getting into the small details
 
 ### Expectations For Early Beta Testers
@@ -36,7 +36,7 @@ wanted to lay out some expectations before getting into the small details
   Provide feedback via the Matrix room, for interactive discussions, or the GitLab issue tracker for larger bug tracking.
 * Feedback should be productive and specific while being as light a load on the beta tester as possible:
     * BAD: "This thing is crap!"
-    * BAD: "It crashed"
+    * BAD: "It crashed!!!!"
     * Good: "When I click on a notification box it didn't seem to do anything until I clicked in a very specific area"
     * Good: "The app seemed to freeze up when I kept scrolling down my timeline for a long time (like half an hour)"
     * Good: "I'm finding X feature hard to use because Y is confusing"
@@ -50,9 +50,9 @@ wanted to lay out some expectations before getting into the small details
     * Typing @ brings up a list of all known fediverse accounts that the app has ever seen as you type (but not all that your server has seen)
     * Typing # brings up a list of all known hashtags that the app has ever seen as you type (but not all that your server has seen)
     * Very basic markdown (wrapping in stars for bold/italics)
-* Adding new images to posts
-    * Image posting with easy means of adding ALT text
-* Attaching existing images to posts
+    * Adding new images to posts 
+      * Image posting with easy means of adding ALT text 
+    * Attaching existing images to posts
 * Resharing posts
 * Browsing timelines including from groups you've created. In this app "Home" is the same as the "Network" (grid) button in Frio and "Yours" is the equivalent of the Home button in the app.
 * Browsing notifications and marking individual ones read or all read
@@ -121,15 +121,8 @@ wanted to lay out some expectations before getting into the small details
 * Adding videos or files to posts
 * Multi-account logins
 
-### Things I could use help from community on:
-* CI/CD
-* Packaging for Linux operating systems using Flatpak, Snap, etc. (or individual packages per operating system)
-* UI/UX cleaning up
-* Graphics design for logo, website art
-* Documentation
-* Spreading the word
 
-General behaviors/problems to be aware of:
+## General behaviors/problems to be aware of:
 
 ### Broken and hopefully fixed in the very near future:
 * Resharing of Diaspora federated posts is currently broken server side. All other posts should be reshareable.

developers.md

@@ -13,3 +13,8 @@ Whenever a model is changed that is stored in ObjectBox it is necessary to execu
 ```bash
 flutter pub run build_runner build
 ```
+
+Whenever building for deployment on a Linux machine you need to manually copy the libobjectbox.so 
+library file into the bundle's lib folder before zipping up. This issue has been filed with the 
+ObjectBox team to address: https://github.com/objectbox/objectbox-dart/issues/504
+

install.md

@@ -46,22 +46,33 @@ prompted again. The system does not work without the storage mechanism at this t
 
 
 ### Linux
-For Linux development be sure that libsecret-1-dev and libjsoncpp-dev are installed on the machine. For running only
-make sure the non-dev versions are...
-
-1. Install libsecret and libjsoncpp from your system's package manager. 
+1. Install libsecret-1-0 and libjsoncpp25 libraries from your system's package manager. 
 2. Download the latest version (see above)
 2. Unzip the archive.
 3. Copy to wherever you want to store the applications
+4. Open a terminal in the location with the executable and execute the command:
+   ```bash
+   export LD_LIBRARY_PATH="$PWD/lib":$LD_LIBRARY_PATH
+   ```
+5. Run the application with `./relatica`
 
-Note #1: At this time the library dependencies on libsecret and libjsoncpp are a bit finicky. 
+Note #1: This LD_LIBRARY_PATH issue is a temporary one while a build/deploy bug is being
+worked out with one of the libraries that the application uses.
+
+Note #2: At this time the library dependencies on libsecret and libjsoncpp are a bit finicky. 
 The build definitely works on Ubuntu 22 or Linux distributions built on Ubuntu 22. Testing
 on other distros hasn't happened yet. Please report results back and we will try to provide
 builds for other distros as they are needed.
 
-Note #2: The app uses Linux's secret storage mechanism. Under testing under Cinnamon the
+Note #3: The app uses Linux's secret storage mechanism. Under testing under Cinnamon the
 access to the storage is reset whenever the user logs out. You therefore will be prompted
 for the password to the secret storage the first time you run the application after logging
 in or rebooting.
 
 ### Windows
+1. Download the latest version (see above)
+2. Unzip the archive.
+3. Copy to wherever you want to store the application
+4. Open up the folder and double-click on the icon
+5. If Windows defender puts up a warning screen hit "more info" to bring up the "Run anyway" button.
+6.