[nongnu] elpa/vm ff461ac98c 1/2: Update and restructure README after move to Gitlab, issue #467

[ELPA Syncer]

branch: elpa/vm
commit ff461ac98c9232b9dbccb49518ba234b4c3b9a21
Author: Göran Uddeborg <goeran@uddeborg.se>
Commit: Göran Uddeborg <goeran@uddeborg.se>

    Update and restructure README after move to Gitlab, issue #467
---
 CONTRIBUTING.md |  14 +++++
 HISTORY.md      |  30 +++++++++++
 README          | 163 --------------------------------------------------------
 README.md       |  72 +++++++++++++++++++++++++
 4 files changed, 116 insertions(+), 163 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..44a93b71ca
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Development and getting involved
+
+First of all, thank you for helping in improving VM!
+
+We maintain the source code in [Git](https://git-scm.com/) at the
+[Gitlab](https://gitlab.com/emacs-vm/vm) forge.
+
+If you want to get the latest development version of VM you may clone
+from there, see the button `Code`. If you want to contribute changes
+you may want to
+[fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html)
+the repository. The project's [issue
+tracker](https://gitlab.com/emacs-vm/vm/-/issues) is where we keep
+track of the bugs that need fixing as well as items on the wishlist.
diff --git a/HISTORY.md b/HISTORY.md
new file mode 100644
index 0000000000..6b70cf9336
--- /dev/null
+++ b/HISTORY.md
@@ -0,0 +1,30 @@
+# History
+
+VM was written by Kyle Jones! Hail Kyle! The last release from Kyle
+was 7.19.
+
+Later versions of VM have been maintained by the user community. For a
+long time VM was hosted in Bazaar on
+[Launchpad](https://launchpad.net/vm).
+
+Since July 2024 the most recent updates are made in the Git repository
+at [Gitlab](https://gitlab.com/emacs-vm/vm) where code and issues have
+been migrated to from the Launchpad repository.
+
+People having made significant contributions to VM include, but are
+not limited to
+- Kyle Jones, the original author.
+- Robert Widhopf-Fenk
+- Uday Reddy
+- Arik Mitschang
+- Ulrich Müller
+- Mark Diekhans
+
+## Unmaintained web pages
+
+This README file holds the most recent information as of July 2024. A
+currently unmaintained [homepage of
+VM](http://www.nongnu.org/viewmail/) is hosted by Savannah. Older
+downloads of VM can also be found here. A currently unmaintained Wiki
+can be found at [Emacs
+Wiki](http://www.emacswiki.org/emacs/CategoryViewMail).
diff --git a/README b/README
deleted file mode 100644
index 541da7fe70..0000000000
--- a/README
+++ /dev/null
@@ -1,163 +0,0 @@
-VM was written by Kyle Jones! Hail Kyle! The last release from Kyle
-was 7.19. 
-
-VM's home page up to version 7.19 on the World Wide Web is at
-http://www.wonderworks.com/vm and the FAQ is still hosted there.
-
-The later versions of VM have been maintained by the user community.
-The current 'VM development team' (vm@lists.launchpad.net) consists of
-of Arik Mitschang, Ulrich Müller and Uday Reddy, but contributions
-from various other users and developers have also been incorporated in
-them.  See the info manual for a full list of contributors.
-
-*******************************************************************************
-VERSION INFO
-
-The VM versions 8.2.0 and up are designed to work with:
-
-- XEmacs version 21.4 or higher, with MULE support
-
-- Gnu Emacs versions 22 or higher
-
-(While Gnu Emacs 21 is permitted, it is not recommended.)
-
-The users of vcard's need a vcard.el package with vcard-api-version
-2.0.  (A suitable version of vcard.el is included in this distribution.)
-
-********************************************************************************
-INSTALLATION
-
-Read INSTALL and follow the instructions to compile and setup VM.
-
-If you are new to VM, see example.vm for example configuration
-settings (to be put into a '~/.vm' file).  Read more in the VM manual on
-'info'.
-
-*******************************************************************************
-BUGS
-
-Please report bugs in VM using the VM function
-          M-x vm-submit-bug-report
-This function formats an email report including the entire state of VM
-which can be used to diagnose and fix the bug.  Please include
-information about how to reproduce the problem.
-
-Please report any problems or bugs otherwise they cannot be fixed!
-
-If you are not sure that the problem is a bug or that it could be of
-general importance to other users, you are welcome to discuss it on
-the USENET groups gnu.emacs.vm.bugs or gnu.emacs.vm.info!  However, it
-is not always possible to diagnose problems without full information
-about your VM settings.  So, filing a bug report is necessary.
-
-*******************************************************************************
-Homepage
-
-The new homepage of VM is at http://www.nongnu.org/viewmail/ hosted by
-Savannah.  The latest downloads of VM can also be found here.
-
-The source code of VM is at http://launchpad.net/vm hosted by
-Launchpad.
-
-Eventually, we may migrate to a single site for both the facilities.  
-
-*******************************************************************************
-Wiki
-
-The Wiki at http://www.emacswiki.org/emacs/CategoryViewMail is best
-suited to conserve code snippets, cooking guides or feature requests.
-
-*******************************************************************************
-Code Repository
-
-We maintain the source code using Bazaar (http://bazaar-vcs.org/).
-
-If you want to get the latest development version of VM, or want to
-contribute changes you may want to branch from the following launchpad
-URI:
-
-  lp:vm
-
-which is short for the full URL:
-
-  http://bazaar.launchpad.net/~vm/vm/trunk
-
-
-# create your own branch from the trunk
-# the 'lp' URL's do they same job as the 'http' URL's above.
-bzr get lp:vm      # for the main trunk
-(or)
-bzr get lp:vm/8.2.x # for the latest version in the 8.2.x series
-# get updates
-bzr pull
-# start hacking 
-emacs vm-pgg.el
-# commit your changes 
-bzr commit
-# Generate a bundle of your changes for merging
-bzr bundle-revisions --output=xy-changes.diff
-# Attach the bundle to a mail (rather than doing cut&paste) and send
-# it to vm @ lists.launchpad.net with a descriptive subject.  
-# Alternatively, upload it to your space on Launchpad
-bzr push lp:~username/vm/branchname
-# Then send a message to vm @ lists.launchpad.net requesting merge
-
-*******************************************************************************
-Get involved
-
-The project home is at 
-
-   http://launchpad.net/vm
-
-Registering on launchpad is a painless process and makes it convenient
-to participate in the development of VM (or other Launchpad projects).
-
-The "Bugs" tracker is where we keep track of the bugs that need fixing
-as well as TODO items.
-
-The "Blueprints" section records our future development plans.
-
-
-*******************************************************************************
-COMMENTS
-
-In addition to Kyle Jones's original VM, this version includes
-various contributions from Robert Widhopf-Fenk and others.
-
-Extensions for VM written by Robert:
-- vm-pine.el         for draft handling and other Pine inspired functions.
-- vm-ps-print.el      for nice ps-printing functions
-- vm-rfaddons.el      adds various add-ons to VM
-- vm-grepmail        a grepmail interface for VM
-- vm-avirtual.el      brings additional virtual folder selectors and functions
-                     for spam tagging
-- vm-biff.el         is a xbiff within VM, notifying you of new mail
-- vm-serial.el       templates for mails, personalized serial mails 
-- vm-summary-faces.el faces based on virtual selectors 
-
-Additional extensions for VM from other people:
-- vm-pcrisis.el              by Rob Hodges for people with personal crisis 
which need
-                     to rewrite headers automatically. 
-- vcard.el            by Noah Friedman <friedman 'at' splode.com> for
-  vm-vcard.el        displaying vcards within VM.
-
-Enhancements:
-
-- Support for reading HTML messages using Emacs packages and external
-applications, as well as replying to HTML messages.
-
-- IMAP folder support by Uday Reddy
-
-- External message support by Uday Reddy
-
-- Thread folding by Arik Mitschang
-
-- Thread operations by Uday Reddy
-
-- S/MIME support by Arik Mitschang
-
-
-Local Variables:
-mode: text
-coding: utf-8
-End:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..4dc06aee40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# The Emacs mail reader VM (a.k.a. ViewMail)
+
+VM is a mail reader that runs under GNU Emacs and XEmacs. It was
+written as an alternative to the Emacs RMAIL mail reader by Kyle
+Jones. VM is highly configurable and easy to use. It supports POP and
+IMAP mail servers, understands MIME, and handles mail folders in the
+standard UNIX mailbox format and the BABYL format used by the RMAIL
+mailer. It has a powerful virtual folder facility to facilitate
+searching as well as more advanced handling of multiple mail folders.
+This site exists to continue VM development community project.
+
+## Version Information
+
+The VM versions 8.2.0 and up are designed to work with:
+
+- XEmacs version 21.4 or higher, with MULE support
+- Gnu Emacs versions 22 or higher
+
+## Installation
+
+Read [INSTALL](INSTALL) and follow the instructions to compile and
+setup VM.
+
+If you are new to VM, see example.vm for example configuration
+settings (to be put into a `~/.vm` file). Read more in the VM manual
+in _info_ format.
+
+## Bugs
+
+The preferred way to report bugs is to file issues at
+https://gitlab.com/emacs-vm/vm/-/issues.
+
+Alternatively, bugs can be reported report in VM using the VM function
+
+```
+M-x vm-submit-bug-report
+```
+
+However, this function currently sends an e-mail to a mailing list,
+which makes the issue hard to track, why the Gitlab issue tracker
+normally is a better option
+
+Please include information about how to reproduce the problem. Please
+report any problems or bugs otherwise they cannot be fixed!
+
+If you are not sure that the problem is a bug or that it could be of
+general importance to other users, you are welcome to discuss it on
+the mailing lists, [see below](#communication).
+
+## Communication
+
+Communication is done on four mailing list (VM **is** a mail reader
+after all):
+
+- [viewmail-info](https://lists.nongnu.org/mailman/listinfo/viewmail-info)
+  for general discussion of VM features and issues.
+- [viewmail-dev](https://lists.nongnu.org/mailman/listinfo/viewmail-dev)
+  for VM development discussions. Developers and users interested in
+  development are both welcome.
+- [viewmail-bugs](https://lists.nongnu.org/mailman/listinfo/viewmail-bugs)
+  for reporting bugs in VM. Bugs reported using `vm-submit-bug-report`
+  go here.
+- 
[viewmail-maintainers](https://lists.nongnu.org/mailman/listinfo/viewmail-maintainers)
+  aimed at at VM maintainers and packagers. The list is public but of
+  limited interest outside its target audience.
+
+## See also
+
+[CONTRIBUTING](CONTRIBUTING.md) for information on how to get involved
+in the project.
+
+[HISTORY](HISTORY.md) for some notes on the history of the project.