diff --git a/README.md b/README.md index bef16ab..65de902 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,6 @@ `NormalizersOfPrimitiveGroups` is a [GAP](https://www.gap-system.org/) package to compute normalizers of primitive groups. -Note: Currently, the package can only be loaded using the master branch of GAP. - -You can use it as follows: - -1. Download `NormalizersOfPrimitiveGroups` and extract it into a GAP `pkg` - directory. - -2. Start GAP and load the `NormalizersOfPrimitiveGroups` package: - - LoadPackage("NormalizersOfPrimitiveGroups"); - -3. You can use the function `NormalizerInSymmetricGroupOfPrimitiveGroup` to - compute the normalizer of a primitive group inside the symmetric group on - the same number of points. - -4. You can use the function `WeakCanonizerOfPrimitiveGroup` to compute a - permutation which conjugates a given primitive group into weak canonical - form and the corresponding socle-component. - -Note: `NormalizerInSymmetricGroupOfPrimitiveGroup` and -`WeakCanonizerOfPrimitiveGroup` are currently **only** implemented for groups -of type PA. - ## Example The following is an example session using this package to compute for a diff --git a/doc/NormalizersOfPrimitiveGroups.autodoc b/doc/NormalizersOfPrimitiveGroups.autodoc new file mode 100644 index 0000000..7716e02 --- /dev/null +++ b/doc/NormalizersOfPrimitiveGroups.autodoc @@ -0,0 +1,38 @@ +@Chapter The NormalizersOfPrimitiveGroups package +@Section Introduction + +`NormalizersOfPrimitiveGroups` is a [GAP](https://www.gap-system.org/) package +to compute normalizers of primitive groups. + +For the correctness of the algorithms see my diss: + TODO some arxiv upload + +Note: Currently, the package can only be loaded using the master branch of GAP. + +@Section Installation + +You can install and use the package as follows: + +1. Download `NormalizersOfPrimitiveGroups` and extract it into a GAP `pkg` + directory. + +2. Start GAP and load the `NormalizersOfPrimitiveGroups` package: + + LoadPackage("NormalizersOfPrimitiveGroups"); + +@Chapter Normalizers of primitive groups + +Note: **only** implemented for groups of type PA. + +3. You can use the function `NormalizerInSymmetricGroupOfPrimitiveGroup` to + compute the normalizer of a primitive group inside the symmetric group on + the same number of points. + +@Chapter Weak canonical forms + +Note: **only** implemented for groups of type PA. + +4. You can use the function `WeakCanonizerOfPrimitiveGroup` to compute a + permutation which conjugates a given primitive group into weak canonical + form and the corresponding socle-component. + diff --git a/makedoc.g b/makedoc.g index f152b7a..85b5ce0 100644 --- a/makedoc.g +++ b/makedoc.g @@ -6,5 +6,16 @@ if fail = LoadPackage("AutoDoc", "2018.02.14") then Error("AutoDoc version 2018.02.14 or newer is required."); fi; +LoadPackage("NormalizersOfPrimitiveGroups"); -AutoDoc( rec( scaffold := true, autodoc := true ) ); +scan_dirs := [ + "doc", + "gap", + ]; + +AutoDoc(rec( + autodoc := rec( scan_dirs := scan_dirs ), + gapdoc := rec(scan_dirs := scan_dirs), + scaffold := true, +)); +QUIT;