Git Product home page Git Product logo

example's Introduction

Build Status Code Coverage

The Example package

This package serves as an example of how to create a GAP 4 package.

The Example package uses an external binary and therefore a complete installation only works on UNIX systems or systems that support a UNIX-like environment, e.g. OS X, or Windows with Cygwin. However, a partial installation without the external binary is possible on any system.

To compile the package, change to the /pkg/example-* directory of your GAP installation and then call

./configure <path>

where is a path to the main GAP root directory; so normally you would call

./configure ../..

(the ../.. is the default and so may be omitted) and then call

make 

to compile the binary.

Now start GAP and type

LoadPackage("example");

to load the package. You will see the package banner. If you have not compiled the external binary, you should receive a warning.

For details on how to use the Example package see the package documentation in the doc subdirectory (view its HTML version or manual.pdf via a PDF viewer). You will find additional information on how to create a GAP package in the Appendix of the manual.

Maintainers:

  • Werner Nickel (before 2002)
  • Greg Gamble (2002-2006)
  • Olexandr Konovalov (since 2011)

example's People

Contributors

alex-konovalov avatar fingolfin avatar frankluebeck avatar gregg0 avatar hulpke avatar isuruf avatar olexandr-konovalov avatar ssiccha avatar thomasbreuer avatar wilfwilson avatar yazgoo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

example's Issues

Document that it is allowed to have both author and maintainer as false

We now permit both of these to be false for contributors who are neither authors nor maintainers. This is useful to give credits to contributors who are in neither of the two categories. The comment should be updated to explain that.

example/PackageInfo.g

Lines 152 to 155 in e9593b0

## # At least one of the following two entries must be given and set
## # to 'true' (an entry can be left out if value is not 'true'):
## IsAuthor := true;
## IsMaintainer := true;

This shows that again we managed to change ValidatePackageInfo without updating the sample PackageInfo.g file :(

Future plans for the Example package

After gap-system/gap#484 has been merged, this package will not have guidelines. It will be a mock package which should demonstrate how to apply those guidelines. I think it should be made closer to look like what https://github.com/gap-system/PackageMaker would create, and it should demonstrate how to use Travis CI and CodeCov to run regression tests and get code coverage reports. That will increase its value, as it will demonstrate to PackageMaker users where to go from the stub package that PackageMaker will produce for them, and show to package authors how to set up CI and code coverage tools.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.