From d875edbc23ac87768676ddc41eb81e0b447d0a07 Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Thu, 15 Aug 2024 14:57:57 -0400 Subject: [PATCH 1/6] Update README.md --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a66e44b84..d194e4282 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ -![MoshidonLogo](mastodon/src/main/res/mipmap-xhdpi/ic_launcher_round.png) - -# Moshidon, the material you mastodon client! +# ![MoshidonLogo](mastodon/src/main/res/mipmap-xhdpi/ic_launcher_round.png) Moshidon, the material you mastodon client! > A fork of [megalodon](https://github.com/sk22/megalodon) which is a fork of [official Mastodon Android app](https://github.com/mastodon/mastodon-android) adding important features that are missing in the official app and possibly won’t ever be implemented, such as the federated timeline, unlisted posting, bookmarks and an image description viewer. +## Downloads -[![Download latest release](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) +[![Download latest release](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk)  [![Download nightly release](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20Nightly%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon-nightly/releases/latest/download/moshidon-nightly.apk) +[![Nightly build](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) [![Translation status](https://translate.codeberg.org/widgets/moshidon/-/svg-badge.svg)](https://translate.codeberg.org/engage/moshidon/)   -[![Nightly build](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) -Get it on Google Play +Get it on Google Play   -Get it on F-Droid +Get it on F-Droid   -Get it on IzzyOnDroid +Get it on IzzyOnDroid -## Help out the project by donating at: https://github.com/sponsors/LucasGGamerM! -### We also support LiberaPay at: https://liberapay.com/LucasGGamerM/donate +## Support the Project +[Github](https://github.com/sponsors/LucasGGamerM) +[Liberapay](https://liberapay.com/LucasGGamerM/donate) +Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` -### You can also donate some Monero through this wallet address as well: -4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j - ---- +--- ## Key features @@ -60,7 +58,7 @@ Allows you to change theme within the app. Supports Material You, purple, pink, **Allows you to post publicly without having your post show up in trends, hashtags or public timelines (i.e., in the tabs “Local”, “Community” and “Posts”).** When posting with Unlisted visibility, your posts will still be publicly accessible in your profile. They will also be shown in people’s Home timelines, but only if they follow you or someone they follow reposted/replied to your post. - + The Mastodon documentation has some more information about [Unlisted posting](https://docs.joinmastodon.org/user/posting/#unlisted) and [Public timelines](https://docs.joinmastodon.org/user/network/#timelines). ### **Federated timeline** @@ -68,7 +66,7 @@ The Mastodon documentation has some more information about [Unlisted posting](ht **This allows you to chronologically see all Public posts from people on all other Fediverse neighborhoods your home instance is connected to.** Despite being one of the main features of federated social media, the Federated timeline wasn’t included in the official Mastodon app – supposedly, because this conflicts with Google’s safety requirements for apps on the Play Store. - + That’s one of the reasons why choosing a small, **well-moderated instance is important**. Instance admins and moderators should always make sure to ban abusive users and stop federating with instances who platform them. On well-moderated instances, the Federated timeline can be a welcoming place to meet new people! ### **Image description viewer** From c86ff1cce4b668486a2868bd01db20979ccd38aa Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Mon, 19 Aug 2024 16:30:50 -0400 Subject: [PATCH 2/6] update Reformatted header buttons and donate section, rewrote blurb, shortened up features descriptions and moved some to FAQ which I will tidy up later --- FAQ.md | 78 ++++++++++++++++++++ README.md | 216 ++++++++++++++++-------------------------------------- 2 files changed, 142 insertions(+), 152 deletions(-) diff --git a/FAQ.md b/FAQ.md index f18a7ca59..a889d5187 100644 --- a/FAQ.md +++ b/FAQ.md @@ -7,3 +7,81 @@ A: There are many, but the most outstanding differences are: the ability to have Q: Will there ever be a version of Moshidon for iOS? A: No. As android and iOS apps do not share code, it is incredibly hard to port. + +# How To + +### Lists & Hashtags + +View, edit, and pin lists. Users can be added or removed from lists on their profile page. [ Your Lists icon ] + +Follow, pin, and mute hashtags. [ Hashtags you follow icon ] +[ Example of hashtag page with pin and mute icons highlighted ] + +### Follow Other Communities + +Easily follow another server's local public posts even if your server does not federate with them by adding it as a Community. Search for the server name and pin it to add it to your Home drop down menu. + +[ Server info page with Local Timeline highlighted ] +[ Then local timeline with pin button highlighted ] + +### Filtered Posts + +Edit your filters without leaving the app. Allows you to have filtered posts collapsed with a warning. [ example filtered post ] + +### Notifications + +Get only specific types of notifications (no more finished polls!), limit who you get notifications from, or group all notifications into one. + +## Detailed changes + +### Features + +* [Adding the ability to view other server's local timelines](https://github.com/LucasGGamerM/moshidon/tree/feature/local-timelines) +* [Adding the ability to load followers and following from remote instance](https://github.com/LucasGGamerM/moshidon/tree/feature/remote-followers) +* [Adding the ability to have filtered posts show with a warning](https://github.com/LucasGGamerM/moshidon/tree/feature/filters_again) +* [Add “Unlisted” as a post visibility option](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/enable-unlisted) + ([Pull request](https://github.com/mastodon/mastodon-android/pull/103)) +* Adding a useful private profile note box +* Auto hiding the compose button on scroll +* Adding the ability to remind yourself to add alt text to images +* An indicator for if an image has alt text or not +* Adding the ability to have drafts +* Also adding the ability to view announcements from your instance +* Adding the ability to post for local timeline only (Only on instances that support it!) +* [Add image description button and viewer](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/display-alt-text) ([Pull request](https://github.com/mastodon/mastodon-android/pull/129)) +* [Implement pinning posts and displaying pinned posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/pin-posts) ([Pull request](https://github.com/mastodon/mastodon-android/pull/140)) +* [Implement deleting and re-drafting](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/delete-redraft) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/21)) +* [Implement a bookmark button and list](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/bookmarks) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/22)) +* [Add “Check for update” button in addition to integrated update checker](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/check-for-update-button) +* [Add “Mark media as sensitive” option](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/mark-media-as-sensitive) +* [Add settings to hide replies and reposts from the timeline](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/filter-home-timeline) ([Pull request](https://github.com/mastodon/mastodon-android/pull/317)) +* [Follow and unfollow hashtags](https://github.com/sk22/megalodon/commit/7d38f031f197aa6cefaf53e39d929538689c1e4e) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/233)) +* [Notification bell for posts](https://github.com/sk22/megalodon/commit/b166ca705eb9169025ef32bbe6315b42491b57ea) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/81)) +* [Viewing lists and adding/removing users from lists](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:list-timeline-views) based on [@obstsalatschuessel](https://github.com/obstsalatschuessel)'s [Pull request](https://github.com/mastodon/mastodon-android/pull/286) +* [List favorited posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/favs-list) +* [Accept/reject follow requests](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/follow-requests) +* [Display content warning title above text](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/cw-above-text) +* [Add notifications tab for posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/posts-notifications-tab) +* [Show visibility of original post when replying](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/display-reply-visibility) +* [Clickable reply/boost line above posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:clickable-boost-reply-line) +* [Clickable reply line while replying to open original post](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/clickable-reply-line-compose) + + +### Behavior + +* Allow for confirmation before reblogging +* Adding a bottom option for the publish button, allowing for easier use on larger screens! +* [Make back button return to the home tab before exiting the app](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/back-returns-home) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/118)) +* [Always preserve content warnings when replying](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/always-preserve-cw) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/113)) +* [Display full image when adding image description](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/compose-image-description-full-image) ([Pull request](https://github.com/mastodon/mastodon-android/pull/182)) +* [Set spoiler height independently to content height](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:spoiler-height-independent) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/166)) +* [Option to hide interaction numbers](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:settings/hide-interaction-numbers) +* [Option to always reveal content warnings](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/cw-above-text) +* [Option to disable scrolling title bars](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:settings/disable-marquee) + + +### Visual + +* [Custom extended footer redesign](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:compact-extended-footer) +* [Improvements to the true black mode](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:true-black-improvements) +* [Profile header tweaks](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:ui/profile-header-tweaks) diff --git a/README.md b/README.md index d194e4282..f1de76c1e 100644 --- a/README.md +++ b/README.md @@ -1,183 +1,96 @@ -# ![MoshidonLogo](mastodon/src/main/res/mipmap-xhdpi/ic_launcher_round.png) Moshidon, the material you mastodon client! +# ![MoshidonLogo](mastodon/src/main/res/mipmap-xhdpi/ic_launcher_round.png) Moshidon, the material you mastodon client! -> A fork of [megalodon](https://github.com/sk22/megalodon) which is a fork of [official Mastodon Android app](https://github.com/mastodon/mastodon-android) adding important features that are missing in the official app and possibly won’t ever be implemented, such as the federated timeline, unlisted posting, bookmarks and an image description viewer. +> A highly customizable up-to-date fork of [megalodon](https://github.com/sk22/megalodon) adding important features such as a fully federated timeline, unlisted posting, drafts, scheduled posts, bookmarks, and alt text warnings. -## Downloads +## Download Now -[![Download latest release](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk)  +Get it on Google Play Get it on F-Droid Get it on IzzyOnDroid -[![Download nightly release](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20Nightly%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon-nightly/releases/latest/download/moshidon-nightly.apk) +[![GitHub Release Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) [![GitHub Nightly Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20Nightly%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon-nightly/releases/latest/download/moshidon-nightly.apk) [![GitHub Nightly Build Download](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) [![Translation status](https://translate.codeberg.org/widgets/moshidon/-/svg-badge.svg)](https://translate.codeberg.org/engage/moshidon/) -[![Nightly build](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) +## Donate -[![Translation status](https://translate.codeberg.org/widgets/moshidon/-/svg-badge.svg)](https://translate.codeberg.org/engage/moshidon/) -  - -Get it on Google Play -  -Get it on F-Droid -  -Get it on IzzyOnDroid - -## Support the Project -[Github](https://github.com/sponsors/LucasGGamerM) -[Liberapay](https://liberapay.com/LucasGGamerM/donate) -Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` +Github | Liberapay | Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` --- -## Key features +## Key Features -### **The ability to add other server's local timeline to your timelines** +### Flexible Timelines -It can be accessed in the "Edit timelines" menu, where you can add a new "Community" to see other server's local posts! +[ Home dropdown menu ] -### **View remote profiles** +Under the Home menu by default you can see your active account's timeline, your server's local timeline, and your server's federated timeline. You can also pin hashtags, lists, other servers, or make a custom view of just your posts, your bookmarks, or your favourites for quick access. Then sort these timelines to prioritize the ones you visit most often. -You can now see all of a profile follows and followers, by directly loading them from the profile's home instance. In case of a failed lookup, the app will automatically fall back to the older method. +[ Edit timelines icon ] +[ Edit timelines menu ] -### **Translate posts easily** +### Multiple Accounts & Crossposting -Allows you to easily translate posts in another language with a translate button! Your instance must support translation, otherwise it will not work. +Sign in to multiple accounts in the same app and easily switch between them. Press and hold on the boost or fave button to boost or fave a post to a different account than the one you are currently browsing with. -### **Show posts filtered with a warning** +[ boost icon pop up select profile ] -Allows you to have filtered posts collapsed with a warning! As shown in the screenshots: +### Drafts & Scheduled Posts -Before | After -:-------------------------:|:-------------------------: -![Screenshot_20230205-100200edited](https://user-images.githubusercontent.com/71328265/216820539-20802dc5-e433-4511-b2d9-291d810e4ef2.png) | ![Screenshot_20230205-100203edited](https://user-images.githubusercontent.com/71328265/216820544-231b2966-f38f-4ec6-b555-d39c62433839.png) +Write posts and save them, or schedule them to post later. Edit and delete your drafts. +### Alt Text Tag & Reminder -### **Color themes** +An unobtrusive ALT tag appears on images with alt text. Clicking on the icon makes the alt text appear. By default, Moshidon will show a warning to add alt text if your post has any attachments lacking alt text. This is for better accessibility, and it can be disabled in settings. You can also hide from your feed all posts that are lacking in alt text. -Allows you to change theme within the app. Supports Material You, purple, pink, green, blue, red, orange, yellow and Nord! +[ image with alt text icon higlighted ] +[ alt text expanded ] +[ settings > behaviour > add alt text reminders and Show media posts with missing alt text ] -### **Unlisted posting** +### Themes & Customization -**Allows you to post publicly without having your post show up in trends, hashtags or public timelines (i.e., in the tabs “Local”, “Community” and “Posts”).** +Moshidon is designed according to Material Design principles. Follow your device's light or dark mode settings or change colour palette - your system's default, purple, black & white, "pitch black" (battery saving) and more. Customize your experience by moving or renaming the publish button, show or hide sensitive media by default, reduce motion, collapse long posts, add haptic feedback, or making the fave button a heart ♥ or a star ★. -When posting with Unlisted visibility, your posts will still be publicly accessible in your profile. They will also be shown in people’s Home timelines, but only if they follow you or someone they follow reposted/replied to your post. +### Not Just Mastodon -The Mastodon documentation has some more information about [Unlisted posting](https://docs.joinmastodon.org/user/posting/#unlisted) and [Public timelines](https://docs.joinmastodon.org/user/network/#timelines). +Supports features available on other types of fediverse servers such as admin announcements, showing pronouns in user names, post translation, emoji reactions, local-only posting, and markdown or html in posts. -### **Federated timeline** +### Fully Federated Feed & Profiles -**This allows you to chronologically see all Public posts from people on all other Fediverse neighborhoods your home instance is connected to.** +See all public posts from servers your server federates with and fetch profiles from a user's local server for accurate up to date information. -Despite being one of the main features of federated social media, the Federated timeline wasn’t included in the official Mastodon app – supposedly, because this conflicts with Google’s safety requirements for apps on the Play Store. - -That’s one of the reasons why choosing a small, **well-moderated instance is important**. Instance admins and moderators should always make sure to ban abusive users and stop federating with instances who platform them. On well-moderated instances, the Federated timeline can be a welcoming place to meet new people! - -### **Image description viewer** - -**Allows you to quickly check whether an image or video has an alternative text attached to it.** - -This is important to **ensure the content you’re sharing is as accessible as possible** to people who can’t see the images and rely on software to read back the provided content descriptions. Thankfully, it’s quite common for people on the Fediverse to provide such alt texts, and hopefully things stay this way! - -### **Reminder to add alt text to attached media** - -By default, Moshidon will show a warning to add alt text if your post has any attachments without any alt text. This is for better accessibility, and it can easily be bypassed and disabled in settings. - -### **Pinning posts** - -**This lets you can highlight important posts on your profile. A dedicated “Pinned” tab in people’s profiles shows all the posts they pinned.** - -On the Fediverse, it’s quite common for people to pin posts they want others to read before following them. You can pin/unpin posts yourself by clicking the `⋯` button in the top right corner of your posts. - -### **Bookmarks** - -**They allow for quickly saving posts and viewing them through the Bookmarks button on the top right of your profile.** - -To bookmark a post, press the button between the Favorite and Share buttons on the bottom of the post. Bookmarks are saved privately, so the post authors won’t know you saved their post – the list of bookmarked posts is only visible to you. - -## Installation - -**Press the download button above to download the APK. Open the downloaded file on your Android device to install it. Moshidon will automatically notify you about new updates inside the app.** - -To install this app on your Android device, download the [latest release from GitHub](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) and open it. You might have to accept installing APK files from your browser when trying to install it. You can also take a look at all releases on the [Releases](https://github.com/LucasGGamerM/moshidon/releases) page. - -Moshidon makes use of [Mastodon for Android](https://github.com/mastodon/mastodon-android)’s automatic update checker. Moshidon will check for new updates available on GitHub and offer to download and install them. You can also manually press “Check for updates” at the bottom of the settings page! - -Moshidon is also available in [IzzyOnDroid repo](https://apt.izzysoft.de/fdroid/index/apk/org.joinmastodon.android.moshinda), compatible with all F-Droid clients. The APK provided here is the same as the one included in the Releases. - -## Release variants - -### Stable variant - -All stable version downloads can be found on the [Releases](https://github.com/LucasGGamerM/moshidon/releases) page. - -**`moshidon.apk`** - -Variant with an integrated updater. If you download Moshidon from here (and not from an app store), just download the regular `moshidon.apk`. - -### Nightly variant - -All nightly builds can be downloaded at [Nightly Releases](https://github.com/LucasGGamerM/moshidon-nightly/releases) page. - -**`moshidon-nightly.apk`** - -Unstable variant with an integrated updater. It's for development and testing purposes. If you find any bugs with it, please file a bug report at our [issues](https://github.com/LucasGGamerM/moshidon/issues) page. +## And more... +- manage pinned posts and bookmarks +- manage lists, filters, and most privacy settings +- display pronouns in timelines, threads, and user listings +- get only specific types of notifications (no more finished polls!), limit who you get notifications from, or group all notifications into one. +- automatically add re: to beginning of replies with content warnings +- ask before boosting or deleting posts +- when replying to a boosted post automatically mention the person who boosted it +- overlay audio from posts, allowing your existing media to keep playing +- auto-reveal CWs that are the same as ones you've already opened, or always reveal content warnings and sensitive media +- hide media previews in timelines (save data) +- show post interaction counts in timeline +- allow custom emoji in display names +- enable scrolling text for long display names +- double tap to open search +- swipe or double swipe between tabs +- hide interaction buttons +- auto-hide compose button +- underline links +- show post dividers +- disable active tab indicator +- show tab labels in navigation bar --- +## Installation & Releases -## Detailed changes +Moshidon is available on GitHub, Google Play, F-Droid, and [IzzyOnDroid repo](https://apt.izzysoft.de/fdroid/index/apk/org.joinmastodon.android.moshinda). All sources provide the same ` moshidon.apk ` stable release. Older releases are available on the [Releases](https://github.com/LucasGGamerM/moshidon/releases) page. -### Features +### How to Install from GitHub +[Download the latest stable release from Github](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) and open it. You might have to accept installing APK files from your browser. Moshidon will automatically check for new updates available on GitHub and offer to download and install them within the app. You can also manually press “Check for updates” at the bottom of the settings page. -* [Adding the ability to view other server's local timelines](https://github.com/LucasGGamerM/moshidon/tree/feature/local-timelines) -* [Adding the ability to load followers and following from remote instance](https://github.com/LucasGGamerM/moshidon/tree/feature/remote-followers) -* [Adding the ability to have filtered posts show with a warning](https://github.com/LucasGGamerM/moshidon/tree/feature/filters_again) -* [Add “Unlisted” as a post visibility option](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/enable-unlisted) - ([Pull request](https://github.com/mastodon/mastodon-android/pull/103)) -* Adding a useful private profile note box -* Auto hiding the compose button on scroll -* Adding the ability to remind yourself to add alt text to images -* An indicator for if an image has alt text or not -* Adding the ability to have drafts -* Also adding the ability to view announcements from your instance -* Adding the ability to post for local timeline only (Only on instances that support it!) -* [Add image description button and viewer](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/display-alt-text) ([Pull request](https://github.com/mastodon/mastodon-android/pull/129)) -* [Implement pinning posts and displaying pinned posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/pin-posts) ([Pull request](https://github.com/mastodon/mastodon-android/pull/140)) -* [Implement deleting and re-drafting](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/delete-redraft) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/21)) -* [Implement a bookmark button and list](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/bookmarks) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/22)) -* [Add “Check for update” button in addition to integrated update checker](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/check-for-update-button) -* [Add “Mark media as sensitive” option](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/mark-media-as-sensitive) -* [Add settings to hide replies and reposts from the timeline](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/filter-home-timeline) ([Pull request](https://github.com/mastodon/mastodon-android/pull/317)) -* [Follow and unfollow hashtags](https://github.com/sk22/megalodon/commit/7d38f031f197aa6cefaf53e39d929538689c1e4e) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/233)) -* [Notification bell for posts](https://github.com/sk22/megalodon/commit/b166ca705eb9169025ef32bbe6315b42491b57ea) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/81)) -* [Viewing lists and adding/removing users from lists](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:list-timeline-views) based on [@obstsalatschuessel](https://github.com/obstsalatschuessel)'s [Pull request](https://github.com/mastodon/mastodon-android/pull/286) -* [List favorited posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/favs-list) -* [Accept/reject follow requests](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/follow-requests) -* [Display content warning title above text](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/cw-above-text) -* [Add notifications tab for posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/posts-notifications-tab) -* [Show visibility of original post when replying](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/display-reply-visibility) -* [Clickable reply/boost line above posts](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:clickable-boost-reply-line) -* [Clickable reply line while replying to open original post](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/clickable-reply-line-compose) +### Nightly Version +All ` moshidon-night.apk ` nightly builds can be downloaded on the [Nightly Releases](https://github.com/LucasGGamerM/moshidon-nightly/releases) page. This is an unstable version with an integrated updater for development and testing purposes and intended for advanced users. If you find any bugs with it, please file a bug report on our [Issues](https://github.com/LucasGGamerM/moshidon/issues) page. - -### Behavior - -* Allow for confirmation before reblogging -* Adding a bottom option for the publish button, allowing for easier use on larger screens! -* [Make back button return to the home tab before exiting the app](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/back-returns-home) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/118)) -* [Always preserve content warnings when replying](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/always-preserve-cw) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/113)) -* [Display full image when adding image description](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/compose-image-description-full-image) ([Pull request](https://github.com/mastodon/mastodon-android/pull/182)) -* [Set spoiler height independently to content height](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:spoiler-height-independent) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/166)) -* [Option to hide interaction numbers](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:settings/hide-interaction-numbers) -* [Option to always reveal content warnings](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/cw-above-text) -* [Option to disable scrolling title bars](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:settings/disable-marquee) - - -### Visual - -* [Custom extended footer redesign](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:compact-extended-footer) -* [Improvements to the true black mode](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:true-black-improvements) -* [Profile header tweaks](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:ui/profile-header-tweaks) - - -## Building +## Building & Contributing As this app is using Java 17 features, you need JDK 17 or newer to build it. Other than that, everything is pretty standard. You can either import the project into Android Studio and build it from there, or run the following command in the project directory: @@ -189,14 +102,13 @@ As this app is using Java 17 features, you need JDK 17 or newer to build it. Oth This project is released under the [GPL-3 License](./LICENSE). -## Links +## Contact & Support + +**@moshidon@floss.social** + +[Official Matrix Chatroom](https://matrix.to/#/#moshidon:floss.social) [F.A.Q](FAQ.md) -[Official matrix chatroom:](https://matrix.to/#/#moshidon:floss.social) https://matrix.to/#/#moshidon:floss.social +[Moshidon Roadmap](https://github.com/users/LucasGGamerM/projects/1) -[Moshidon roadmap](https://github.com/users/LucasGGamerM/projects/1) - -@moshidon@floss.social - ---- From 00b934dc6919c7d7078945b71dd9166fbfa646c7 Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Mon, 19 Aug 2024 16:34:22 -0400 Subject: [PATCH 3/6] spacing and lines it was bothering me --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1de76c1e..0a7d88829 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # ![MoshidonLogo](mastodon/src/main/res/mipmap-xhdpi/ic_launcher_round.png) Moshidon, the material you mastodon client! -> A highly customizable up-to-date fork of [megalodon](https://github.com/sk22/megalodon) adding important features such as a fully federated timeline, unlisted posting, drafts, scheduled posts, bookmarks, and alt text warnings. + +> A fast, highly customizable, up-to-date fork of [megalodon](https://github.com/sk22/megalodon) adding important features such as a fully federated timeline, unlisted posting, drafts, scheduled posts, bookmarks, and alt text warnings. + ## Download Now @@ -12,8 +14,6 @@ Github | Liberapay | Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` ---- - ## Key Features ### Flexible Timelines @@ -78,7 +78,6 @@ See all public posts from servers your server federates with and fetch profiles - disable active tab indicator - show tab labels in navigation bar ---- ## Installation & Releases From d47e1939d0b0a83fe75e45642d16e50e04ad417e Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:18:42 -0400 Subject: [PATCH 4/6] formatting --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0a7d88829..8ee78f2c8 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,25 @@ Get it on Google Play Get it on F-Droid Get it on IzzyOnDroid -[![GitHub Release Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) [![GitHub Nightly Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20Nightly%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon-nightly/releases/latest/download/moshidon-nightly.apk) [![GitHub Nightly Build Download](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) [![Translation status](https://translate.codeberg.org/widgets/moshidon/-/svg-badge.svg)](https://translate.codeberg.org/engage/moshidon/) +[![GitHub Release Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) [![Translation status](https://translate.codeberg.org/widgets/moshidon/-/svg-badge.svg)](https://translate.codeberg.org/engage/moshidon/) [![GitHub Nightly Download](https://img.shields.io/badge/dynamic/json?color=282C37&label=Download%20Nightly%20APK&query=%24.tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2FLucasGGamerM%2Fmoshidon%2Freleases%2Flatest&style=for-the-badge)](https://github.com/LucasGGamerM/moshidon-nightly/releases/latest/download/moshidon-nightly.apk) [![GitHub Nightly Build Download](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml/badge.svg)](https://github.com/LucasGGamerM/moshidon/actions/workflows/nightly-builds.yml) ## Donate -Github | Liberapay | Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` +Github Sponsors | Liberapay | Monero Wallet Key: `4886mdarcyB6Yf8Qc6vDJBK1fz6ibHFLZUmHb4GZZz9yLGNhcG3XC64e5UZ8dVQYTLZb82W6P9WhteowW4STJEec97Gf22j` ## Key Features +[ screenshot of full timeline in default colour scheme ] +[ screenshot of full timeline in an alt colour scheme ] +[ screenshot of profile page ] +[ screenshot of compose post window ] + ### Flexible Timelines [ Home dropdown menu ] Under the Home menu by default you can see your active account's timeline, your server's local timeline, and your server's federated timeline. You can also pin hashtags, lists, other servers, or make a custom view of just your posts, your bookmarks, or your favourites for quick access. Then sort these timelines to prioritize the ones you visit most often. -[ Edit timelines icon ] -[ Edit timelines menu ] - ### Multiple Accounts & Crossposting Sign in to multiple accounts in the same app and easily switch between them. Press and hold on the boost or fave button to boost or fave a post to a different account than the one you are currently browsing with. @@ -41,13 +43,12 @@ An unobtrusive ALT tag appears on images with alt text. Clicking on the icon mak [ image with alt text icon higlighted ] [ alt text expanded ] -[ settings > behaviour > add alt text reminders and Show media posts with missing alt text ] ### Themes & Customization Moshidon is designed according to Material Design principles. Follow your device's light or dark mode settings or change colour palette - your system's default, purple, black & white, "pitch black" (battery saving) and more. Customize your experience by moving or renaming the publish button, show or hide sensitive media by default, reduce motion, collapse long posts, add haptic feedback, or making the fave button a heart ♥ or a star ★. -### Not Just Mastodon +### Not Just For Mastodon Supports features available on other types of fediverse servers such as admin announcements, showing pronouns in user names, post translation, emoji reactions, local-only posting, and markdown or html in posts. @@ -56,11 +57,12 @@ Supports features available on other types of fediverse servers such as admin an See all public posts from servers your server federates with and fetch profiles from a user's local server for accurate up to date information. ## And more... +- quote-posts - links to fediverse posts in other posts will be loaded inline like quote-tweets - manage pinned posts and bookmarks - manage lists, filters, and most privacy settings - display pronouns in timelines, threads, and user listings - get only specific types of notifications (no more finished polls!), limit who you get notifications from, or group all notifications into one. -- automatically add re: to beginning of replies with content warnings +- automatically add "re:" to beginning of replies with content warnings - ask before boosting or deleting posts - when replying to a boosted post automatically mention the person who boosted it - overlay audio from posts, allowing your existing media to keep playing @@ -69,25 +71,19 @@ See all public posts from servers your server federates with and fetch profiles - show post interaction counts in timeline - allow custom emoji in display names - enable scrolling text for long display names -- double tap to open search -- swipe or double swipe between tabs - hide interaction buttons -- auto-hide compose button -- underline links - show post dividers -- disable active tab indicator -- show tab labels in navigation bar ## Installation & Releases -Moshidon is available on GitHub, Google Play, F-Droid, and [IzzyOnDroid repo](https://apt.izzysoft.de/fdroid/index/apk/org.joinmastodon.android.moshinda). All sources provide the same ` moshidon.apk ` stable release. Older releases are available on the [Releases](https://github.com/LucasGGamerM/moshidon/releases) page. +Moshidon is available on GitHub, Google Play, F-Droid, and the IzzyOnDroid repo. All sources provide the same ` moshidon.apk ` stable release. Older releases are available on the [Releases](https://github.com/LucasGGamerM/moshidon/releases) page. ### How to Install from GitHub [Download the latest stable release from Github](https://github.com/LucasGGamerM/moshidon/releases/latest/download/moshidon.apk) and open it. You might have to accept installing APK files from your browser. Moshidon will automatically check for new updates available on GitHub and offer to download and install them within the app. You can also manually press “Check for updates” at the bottom of the settings page. ### Nightly Version -All ` moshidon-night.apk ` nightly builds can be downloaded on the [Nightly Releases](https://github.com/LucasGGamerM/moshidon-nightly/releases) page. This is an unstable version with an integrated updater for development and testing purposes and intended for advanced users. If you find any bugs with it, please file a bug report on our [Issues](https://github.com/LucasGGamerM/moshidon/issues) page. +All ` moshidon-night.apk ` nightly builds can be downloaded on the [Nightly Releases](https://github.com/LucasGGamerM/moshidon-nightly/releases) page. This is an unstable version with an integrated updater for development and testing purposes. If you find any bugs with it, please file a bug report on our [Issues](https://github.com/LucasGGamerM/moshidon/issues) page. ## Building & Contributing From 61b933655c8b1a289f88d14fd1b2cf61ccf23900 Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:22:13 -0400 Subject: [PATCH 5/6] clean up removing stuff I dropped in there earlier --- FAQ.md | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/FAQ.md b/FAQ.md index a889d5187..548d12011 100644 --- a/FAQ.md +++ b/FAQ.md @@ -8,30 +8,6 @@ Q: Will there ever be a version of Moshidon for iOS? A: No. As android and iOS apps do not share code, it is incredibly hard to port. -# How To - -### Lists & Hashtags - -View, edit, and pin lists. Users can be added or removed from lists on their profile page. [ Your Lists icon ] - -Follow, pin, and mute hashtags. [ Hashtags you follow icon ] -[ Example of hashtag page with pin and mute icons highlighted ] - -### Follow Other Communities - -Easily follow another server's local public posts even if your server does not federate with them by adding it as a Community. Search for the server name and pin it to add it to your Home drop down menu. - -[ Server info page with Local Timeline highlighted ] -[ Then local timeline with pin button highlighted ] - -### Filtered Posts - -Edit your filters without leaving the app. Allows you to have filtered posts collapsed with a warning. [ example filtered post ] - -### Notifications - -Get only specific types of notifications (no more finished polls!), limit who you get notifications from, or group all notifications into one. - ## Detailed changes ### Features From 89f27984b735fa11b353ea31197d0e77c9fdeef9 Mon Sep 17 00:00:00 2001 From: Ruth Collings <4490706+collingsr@users.noreply.github.com> Date: Thu, 22 Aug 2024 14:22:30 -0400 Subject: [PATCH 6/6] Update FAQ.md Co-authored-by: FineFindus <63370021+FineFindus@users.noreply.github.com> --- FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/FAQ.md b/FAQ.md index 548d12011..295784d0c 100644 --- a/FAQ.md +++ b/FAQ.md @@ -45,7 +45,7 @@ A: No. As android and iOS apps do not share code, it is incredibly hard to port. ### Behavior -* Allow for confirmation before reblogging +* Ask for confirmation before reblogging * Adding a bottom option for the publish button, allowing for easier use on larger screens! * [Make back button return to the home tab before exiting the app](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/back-returns-home) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/118)) * [Always preserve content warnings when replying](https://github.com/mastodon/mastodon-android/compare/master...sk22:megalodon:feature/always-preserve-cw) ([Closes issue](https://github.com/mastodon/mastodon-android/issues/113))