From 07183d0ea83fc8adbef71f20b0fc532038fbfd0c Mon Sep 17 00:00:00 2001 From: Thomas More Date: Fri, 13 Sep 2024 08:19:59 -0400 Subject: [PATCH] Update documentation --- CONTRIBUTING.md | 1 + README.md | 4 ++++ fastlane/metadata/android/en-US/changelogs/107.txt | 6 +++++- tools/Tools.md | 10 ++++++---- 4 files changed, 16 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d28fefd..5378a59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,3 +51,4 @@ The primary author of SMS Import / Export is [Thomas More](https://github.com/tm - [Biswapriyo Nath (Biswa96)](https://github.com/Biswa96): [GitHub workflow to automatically build and upload APKs containing the latest committed code](.github/workflows/build.yml) ([PR #99](https://github.com/tmo1/sms-ie/pull/99)) - [wittmane](https://github.com/wittmane), [dshepsis](https://github.com/dshepsis), and [sshaikh](https://github.com/sshaikh): figuring out broken `Subscription ID` handling on Android 14 ([Issue #128](https://github.com/tmo1/sms-ie/issues/128)) - [Artem13327](https://github.com/Artem13327): [Update to automatic build and upload Github workflow](https://github.com/tmo1/sms-ie/pull/158) + - [sta-c0000](https://github.com/sta-c0000): [Message browser tool](https://github.com/tmo1/sms-ie/pull/208) diff --git a/README.md b/README.md index 6f350f8..039d67d 100644 --- a/README.md +++ b/README.md @@ -261,6 +261,10 @@ SMS Import / Export has been translated (from the original English) into the fol To add a translation into a new language, or to correct, update, or improve an existing translation, see [here](CONTRIBUTING.md). +## Tools + +The [`tools`](/tools/) directory contains various tools that may be useful in conjunction with SMS Import / Export; see [`Tools.md`](/tools/Tools.md) for details and documentation. + ## TODO The following are various features and improvements to the app that have been suggested and may be implemented in the future: diff --git a/fastlane/metadata/android/en-US/changelogs/107.txt b/fastlane/metadata/android/en-US/changelogs/107.txt index 9b06eb2..61b9975 100644 --- a/fastlane/metadata/android/en-US/changelogs/107.txt +++ b/fastlane/metadata/android/en-US/changelogs/107.txt @@ -1,2 +1,6 @@ - - Update German translation + - Fix a regression that caused outgoing SMS messages with addresses (phone numbers) containing spaces to be skipped when importing (see issues #159, #205, and #128). + + - Update German and Russian translations. + + - Update Gradle build configuration. diff --git a/tools/Tools.md b/tools/Tools.md index d4d287c..1421001 100644 --- a/tools/Tools.md +++ b/tools/Tools.md @@ -62,18 +62,20 @@ This script converts SMS messages in CSV format to SMS I/E compatible JSON. The ## Contributed Tools -This section lists tools for SMS I/E provided by other developers. +The `tools/contrib` directory contains tools for use with SMS I/E that have been contributed by outside developers to the SMS I/E project. ### [`messages_browser.py`](contrib/messages_browser.py) -Platform independent utility to browse SMS and MMS messages zip archive files exported by SMS I/E. (In a similar style to how they appear in Android.) +This is a platform independent utility to browse collections of SMS and MMS messages (included binary MMS attachments) exported by SMS I/E (in the `v2` ZIP file format). The messages are displayed similarly to how they are displayed by the standard Android "Messaging" app. + +To use, run: `messages_browser.py messages-xxx.zip` -(Runs a local HTTP server that can also serve other devices on the LAN if your firewall permits it.) +and then visit `http://127.0.0.1:8222` in a web browser. ## External Tools -This section lists tools that are not developed or supported by the developers of SMS I/E, but may be of interest to users of the app. Descriptions of the tools are taken from their documentation: +This section lists tools for use with SMS I/E that have been developed, and are distributed, by outside developers. Descriptions of the tools are taken from their documentation: - [Call Log Analyzer](https://github.com/guruor/analyze-call-logs): "This simple and intuitive web app lets you visualize your call logs in a beautiful chart format." (Processes call logs exported by SMS I/E.)