Merge pull request #23 from gap-packages/readme

enhance README.md

CHANGES.md

@@ -1,5 +1,7 @@
 # CHANGES to the IdRel package
 
+## 2.48 -> 2.48dev for GAP 4.14.0 (03/01/25) 
+
 ## 2.47 -> 2.48 for GAP 4.13.1 (27/08/24) 
  * (27/08/24) small fix in MonoidPresentationFpGroup method
 

PackageInfo.g

@@ -8,8 +8,8 @@ SetPackageInfo( rec(
 
 PackageName := "idrel",
 Subtitle := "Identities among relations",
-Version := "2.48",
-Date := "06/12/2024", # dd/mm/yyyy format
+Version := "2.48dev",
+Date := "03/01/2025", # dd/mm/yyyy format
 License := "GPL-2.0-or-later",
 
 Persons := [
@@ -47,7 +47,7 @@ SourceRepository := rec(
 ArchiveFormats   := ".tar.gz",
 
 AbstractHTML :=
-"IdRel is a package for computing the identities among relations of a group presentation using rewriting, logged rewriting, monoid polynomials, module polynomials and Y-sequences.",
+"<span class=\"pkgname\">IdRel</span> is a package for computing the identities among relations of a group presentation using rewriting, logged rewriting, monoid polynomials, module polynomials and Y-sequences.",
 
 PackageDoc := rec(
   BookName  := "IdRel",
@@ -81,7 +81,7 @@ BannerString := Concatenation(
 AutoDoc := rec(
     TitlePage := rec(
         Copyright := Concatenation(
-            "&copyright; 1999-2024 Anne Heyworth and Chris Wensley<P/>\n",
+            "© 1999-2025 Anne Heyworth and Chris Wensley<P/>\n",
             "The &IdRel; package is free software; you can redistribute it ", 
             "and/or modify it under the terms of the GNU General ", 
             "Public License as published by the Free Software Foundation; ", 

README.md

@@ -5,31 +5,31 @@
 
 ## Introduction
 
-The IdRel package is designed for computing the identities among relations 
+The 'IdRel' package is designed for computing the identities among relations 
 of a group presentation using rewriting, logged rewriting, 
 monoid polynomials, module polynomials and Y-sequences.
 
 ## History
 
-Version 1.001 of IdRel formed part of Anne Heyworth's PhD thesis in
+Version 1.001 of 'IdRel' formed part of Anne Heyworth's PhD thesis in
 December 1999.
 Version 2.02 was prepared for the GAP 4.4 release in March 2006 
 and deposited in the incoming directory on the St Andrews ftp server.
 A more detailed history will be included as Chapter 6 of the manual.
-IdRel became an accepted package in May 2015. 
+'IdRel' became an accepted package in May 2015. 
 
 ## Distribution
 
-The IdRel package is distributed with the accepted GAP packages.
+The 'IdRel' package is distributed with the accepted GAP packages.
 It may also be obtained from the GitHub repository at:
   <https://gap-packages.github.io/idrel/> 
 
 ## Copyright
 
-The IdRel package is Copyright {\copyright} Chris Wensley and Anne Heyworth, 
-1999--2024. 
+The 'IdRel' package is Copyright © Chris Wensley and Anne Heyworth, 
+1999--2025. 
 
-IdRel is free software; you can redistribute it and/or modify it 
+'IdRel' is free software; you can redistribute it and/or modify it 
 under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version. 
@@ -41,17 +41,17 @@ For details, see <https://www.gnu.org/licenses/gpl.html>.
  * Unpack `idrel-<version_number>.tar.gz` in the `pkg` subdirectory 
    of the GAP root directory.
  * From within GAP load the package with:
-
+    ```
     gap> LoadPackage("idrel");
-
     true
-
+    ```
  * The documentation is in the `doc` subdirectory.
  * To run the test file read `testall.g` from the `idrel/tst/` directory. 
 
 ## Contact
 
-If you have a question relating to IdRel, encounter any problems, or have a suggestion for extending the package in any way, please 
- * email: [email protected] 
+If you have a question relating to 'IdRel', encounter any problems, 
+or have a suggestion for extending the package in any way, please 
+ * email: <mailto:[email protected]> 
  * or report an issue at the GitHub issue tracker: 
    <https://github.com/gap-packages/idrel/issues/new>