From 801f37f82aadc6e2988dabffa514172202d14748 Mon Sep 17 00:00:00 2001 From: djvangerwen Date: Fri, 15 Apr 2022 13:34:08 +0200 Subject: [PATCH] update readme to mention limited platform support --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bc21178..38f5cda 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # notsotuf -A simple software updater for stand-alone Python *applications*, built on top of [python-tuf][1], the reference implementation for [TUF][2] (The Update Framework). +A simple software updater for stand-alone Python *applications* on Windows. + +The package can be used on other platforms, but these are not actively supported. + +The `notsotuf` package is built on top of [python-tuf][1], the reference implementation for [TUF][2] (The Update Framework). ## About @@ -35,14 +39,14 @@ See the [tuf docs][4] for more information. ## Archives and patches -Notsotuf works with *archives* (gzipped PyInstaller bundles) and *patches* (binary differences between subsequent archives). +Notsotuf works with *archives* (e.g. gzipped PyInstaller bundles) and *patches* (binary differences between subsequent archives). Each archive, except the first one, must have a corresponding patch file. Archive filenames and patch filenames follow the pattern `-` -where `name` is a short string that may contain alphanumeric characters, underscores, and hyphens, `version` is a version string according to the [PEP440][6] specification, and `suffix` is either `'.gz'` or `'.patch'`. +where `name` is a short string that may contain alphanumeric characters, underscores, and hyphens, `version` is a version string according to the [PEP440][6] specification, and `suffix` is either `'.gz'` (including `'.tar.gz'`) or `'.patch'`. Patches are typically smaller than archives, so the notsotuf client will always attempt to update using one or more patches. However, if the total amount of patch data is greater than the desired full archive file, a full update will be performed. @@ -82,6 +86,14 @@ From here on, new updates will be deployed using `notsotuf`. 4. Set up your `notsotuf` repository (on the same server or another server), but keep the `pyupdater` repository in place as long as necessary to allow all clients to update. 5. From now on, build, package, sign and deploy using `notsotuf`, as described elsewhere in this document. +## Platform support + +The `notsotuf` package is aimed primarily at **Windows** applications. +Basic `notsotuf.client` functionality should also work on Mac or Linux, provided a custom `move_and_exit` hook is specified in `Client.update()`. +However, these platforms are not actively supported. +Moreover, Linux applications are probably better off using native packaging solutions, or solutions such as Flatpak or Snapcraft. + +Read the [Python packaging overview][8] for more information. [1]: https://github.com/theupdateframework/python-tuf [2]: https://theupdateframework.io/ @@ -89,4 +101,5 @@ From here on, new updates will be deployed using `notsotuf`. [4]: https://theupdateframework.io/overview/#software-updates-101 [5]: https://peps.python.org/pep-0458/ [6]: https://peps.python.org/pep-0440/ -[7]: https://github.com/theupdateframework/python-tuf/blob/develop/examples/repo_example/basic_repo.py \ No newline at end of file +[7]: https://github.com/theupdateframework/python-tuf/blob/develop/examples/repo_example/basic_repo.py +[8]: https://packaging.python.org/en/latest/overview/