From b3eab414dd6aa97e09ccc041f955a35bb1a9112b Mon Sep 17 00:00:00 2001 From: NRK Date: Thu, 27 Jun 2024 08:07:44 +0000 Subject: add a migration document (#507) this should've been added ages ago back when `nsxiv` was first released. but even now, there's still plently of people who might be looking to migrate. so add a simple MIGRATION.md which covers some of the differences to be aware of when migrating. this does not cover patches and `config.h` since any conflicts in patches would be evident anyways. ref: https://codeberg.org/nsxiv/nsxiv/issues/369 ref: https://codeberg.org/nsxiv/nsxiv/issues/506 ref: https://codeberg.org/nsxiv/nsxiv/issues/420 Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/507 Reviewed-by: eylles --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e8ce9e9..6c97250 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,13 @@ interface and adding simple, sensible features. nsxiv is free software licensed under GPL-2.0-or-later and aims to be easy to modify and customize. Please file a bug report if something does not work as documented or expected on -[Codeberg] after making sure you are using the latest release. Contributions -are welcome, see [CONTRIBUTING] to get started. +[Codeberg] after making sure you are using the latest release. If you're looking +to migrate from `sxiv`, see [MIGRATION]. Contributions are welcome, see +[CONTRIBUTING] to get started. [Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new [CONTRIBUTING]: etc/CONTRIBUTING.md#contribution-guideline +[MIGRATION]: etc/MIGRATION.md Features -- cgit v1.2.3-54-g00ecf