Apply PackageJanitor

Author: zickgraf

.github/workflows/Tests.yml

@@ -37,17 +37,3 @@ jobs:
           TERM=dumb make -C FinSetsForCAP -j $(nproc) --output-sync ci-test
           cp ./FinSetsForCAP/.codecov.yml ./
           curl -s https://codecov.io/bash | bash
-          cd FinSetsForCAP
-          CUR_SHA=$(git rev-parse --verify HEAD)
-          git worktree add branch_doc/ doc || (echo "There was an error. Make sure there is a branch named 'doc'. See https://github.com/homalg-project/PackageJanitor#error-there-was-an-error-make-sure-there-is-a-branch-named-doc"; exit 1)
-          cp doc/manual.pdf branch_doc/FinSetsForCAP.pdf
-          cd branch_doc
-          git add FinSetsForCAP.pdf
-          git -c user.name='Doc Bot' -c user.email='empty' commit -m "Add FinSetsForCAP.pdf for $CUR_SHA" --allow-empty
-          cd ..
-          # push iff using gap-stable and if on master branch
-          if [ "${{ matrix.image }}" = "gapsystem/gap-docker" ] && [ "$CUR_SHA" = "$(git rev-parse origin/master)" ]; then \
-            git push https://${GITHUB_ACTOR}:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git doc:doc; \
-          else \
-            echo "Not pushing result."; \
-          fi; \

LICENSE

@@ -1,24 +1,12 @@
-FinSetsForCAP is free software; you can redistribute 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 opinion) any later version.
-
-FinSetsForCAP is distributed in the hope that it will be useful, 
-but WITHOUT ANY WARRANTY; without even the implied warranty of 
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-Version 2 of the GNU General Public License follows.
-
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-			    Preamble
+                            Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -68,8 +56,7 @@ patent must be licensed for everyone's free use or not licensed at all.
   The precise terms and conditions for copying, distribution and
 modification follow.
 
-
-		    GNU GENERAL PUBLIC LICENSE
+                    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -124,7 +111,6 @@ above, provided that you also meet all of these conditions:
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
 
-
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -183,7 +169,6 @@ access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
 
-
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -241,7 +226,6 @@ impose that choice.
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
 
-
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -271,7 +255,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-			    NO WARRANTY
+                            NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -293,5 +277,63 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-		     END OF TERMS AND CONDITIONS
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program 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.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
 
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

PackageInfo.g

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # This file contains package meta data. For additional information on
@@ -76,9 +76,9 @@ SourceRepository := rec(
     URL := "https://github.com/homalg-project/FinSetsForCAP",
 ),
 IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
-PackageWWWHome  := "https://github.com/homalg-project/FinSetsForCAP",
-PackageInfoURL  := "https://raw.githubusercontent.com/homalg-project/FinSetsForCAP/master/PackageInfo.g",
-README_URL      := "https://raw.githubusercontent.com/homalg-project/FinSetsForCAP/master/README.md",
+PackageWWWHome  := "https://homalg-project.github.io/FinSetsForCAP",
+PackageInfoURL  := "https://homalg-project.github.io/FinSetsForCAP/PackageInfo.g",
+README_URL      := "https://homalg-project.github.io/FinSetsForCAP/README.md",
 ArchiveURL      := Concatenation( "https://github.com/homalg-project/FinSetsForCAP/releases/download/v", ~.Version, "/FinSetsForCAP-", ~.Version ),
 # END URLS
 

README.md

@@ -1,17 +1,27 @@
 <!-- BEGIN HEADER -->
 # FinSetsForCAP – The elementary topos of (skeletal) finite sets
 
-| **Documentation**         | **Build Status**                                            |
-|:-------------------------:|:-----------------------------------------------------------:|
-| [![][docs-img]][docs-url] | [![][tests-img]][tests-url] [![][codecov-img]][codecov-url] |
+| Documentation | Build Status | Code Coverage |
+| ------------- | ------------ | ------------- |
+| [![HTML stable documentation][docs-img]][docs-url] | [![Build Status][tests-img]][tests-url] | [![Code Coverage][codecov-img]][codecov-url] |
+
+### Dependencies
+
+To obtain current versions of all dependencies, clone the following repositories:
+1. **homalg_project**: https://github.com/homalg-project/homalg_project
+2. **CAP_project**: https://github.com/homalg-project/CAP_project
+3. **Toposes**: https://github.com/homalg-project/Toposes
+
+---
+
 <!-- END HEADER -->
 
 <!-- BEGIN FOOTER -->
-[docs-img]: https://img.shields.io/badge/PDF-dev-blue.svg
-[docs-url]: /../../raw/doc/FinSetsForCAP.pdf
+[docs-img]: https://img.shields.io/badge/HTML-stable-blue.svg
+[docs-url]: https://homalg-project.github.io/FinSetsForCAP/doc/chap0_mj.html
 
-[tests-img]: https://github.com/homalg-project/FinSetsForCAP/workflows/Tests/badge.svg
-[tests-url]: https://github.com/homalg-project/FinSetsForCAP/actions?query=workflow%3ATests
+[tests-img]: https://github.com/homalg-project/FinSetsForCAP/workflows/Tests/badge.svg?branch=master
+[tests-url]: https://github.com/homalg-project/FinSetsForCAP/actions?query=workflow%3ATests+branch%3Amaster
 
 [codecov-img]: https://codecov.io/gh/homalg-project/FinSetsForCAP/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/homalg-project/FinSetsForCAP

gap/FinSetsForCAP.gd

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Declarations

gap/FinSetsForCAP.gi

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Implementations

gap/SkeletalFinSetsForCAP.gd

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Declarations

gap/SkeletalFinSetsForCAP.gi

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Implementations

init.g

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Reading the declaration part of the package.

make_dist.sh

@@ -2,4 +2,4 @@
 
 base_dir="$PWD"
 
-./release --srcdir ${base_dir} --webdir ${base_dir}/gh-pages --update-file ${base_dir}/gh-pages/update.g $@
+./release-gap-package --srcdir ${base_dir} --webdir ${base_dir}/gh-pages --update-file ${base_dir}/gh-pages/update.g $@

makedoc.g

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # This file is a script which compiles the package manual.

makedoc_with_overfull_hbox_warnings.g

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # This file is a script which compiles the package manual and prints overfull hbox warnings.

read.g

@@ -1,4 +1,4 @@
-#
+# SPDX-License-Identifier: GPL-2.0-or-later
 # FinSetsForCAP: The elementary topos of (skeletal) finite sets
 #
 # Reading the implementation part of the package.