From 049f414af5714105d6b7a862c61d592dbd305e24 Mon Sep 17 00:00:00 2001 From: "Max Base (Seyyed Ali Mohammadiyeh)" Date: Wed, 9 Apr 2025 13:21:25 +0330 Subject: [PATCH 1/4] improve: Make it easier for other people to follow package-maker --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 900e198..e81e579 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,25 @@ You can use it as follows: git clone https://github.com/gap-packages/PackageMaker -2. Start GAP, load the `PackageMaker` package and run the package wizard: +Or, if you're familiar with `PackageManager`, you may want to install `PackageMaker` by `PackageManager`, which is easier to use and automatically installs packages for you by leveraging [PackageManager](https://github.com/gap-packages/PackageManager). + + InstallPackage("PackageMaker"); + +2. Start GAP, load the `PackageMaker` package: LoadPackage("PackageMaker"); + +3. Run the package wizard: + PackageWizard(); -3. Answer the questions about your new package. Afterwards, `PackageMaker` +4. Answer the questions about your new package. Afterwards, `PackageMaker` creates a new directory for the new package and populates it with all the files needed for a basic package. -4. Move the newly created package directory to a suitable place. +5. Move the newly created package directory to a suitable place. + +> Note: The `PackageWizard` function generates your new package in the current directory, not automatically in the `pkg` directory. You will need to manually move the generated directory to the `pkg` folder in your GAP installation. Next, you may wish to learn more about the purpose of the various generated files as well as the the meaning and correct usage of the From 82497f33ce15b638796e45acbcae856ff4db129a Mon Sep 17 00:00:00 2001 From: Max Base Date: Wed, 9 Apr 2025 13:39:07 +0330 Subject: [PATCH 2/4] Update README.md Co-authored-by: James Mitchell --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e81e579..2498050 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ You can use it as follows: git clone https://github.com/gap-packages/PackageMaker -Or, if you're familiar with `PackageManager`, you may want to install `PackageMaker` by `PackageManager`, which is easier to use and automatically installs packages for you by leveraging [PackageManager](https://github.com/gap-packages/PackageManager). +Or, you may want to install `PackageMaker` using the [PackageManager](https://github.com/gap-packages/PackageManager) GAP package by typing `LoadPackage("PackageManager"); InstallPackage("PackageMaker");` in GAP. InstallPackage("PackageMaker"); From bc6c2451d5005f431999115143571b34dcbbdf69 Mon Sep 17 00:00:00 2001 From: Max Base Date: Thu, 10 Apr 2025 15:45:15 +0330 Subject: [PATCH 3/4] Update README.md Co-authored-by: Max Horn --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2498050..4765717 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,10 @@ You can use it as follows: git clone https://github.com/gap-packages/PackageMaker -Or, you may want to install `PackageMaker` using the [PackageManager](https://github.com/gap-packages/PackageManager) GAP package by typing `LoadPackage("PackageManager"); InstallPackage("PackageMaker");` in GAP. +Alternatively you could install `PackageMaker` using the [PackageManager](https://github.com/gap-packages/PackageManager) GAP package by entering these commands in GAP: - InstallPackage("PackageMaker"); + LoadPackage("PackageManager"); + InstallPackage("https://github.com/gap-packages/PackageMaker"); 2. Start GAP, load the `PackageMaker` package: From 23d27f5cf15914bce8f0c19123ae199ff9c7bc2d Mon Sep 17 00:00:00 2001 From: Max Base Date: Thu, 10 Apr 2025 15:46:46 +0330 Subject: [PATCH 4/4] Update README.md Co-authored-by: Max Horn --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4765717..f78093e 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Alternatively you could install `PackageMaker` using the [PackageManager](https: 5. Move the newly created package directory to a suitable place. > Note: The `PackageWizard` function generates your new package in the current directory, not automatically in the `pkg` directory. You will need to manually move the generated directory to the `pkg` folder in your GAP installation. +Or just start GAP inside the `pkg` directory. Next, you may wish to learn more about the purpose of the various generated files as well as the the meaning and correct usage of the