Giter Club home page Giter Club logo

fungraphics's Introduction

The FunGraphics library

A library used for teaching computer science in the ISC degree programme, notably for the course 101.1 Imperative programming.

The documentation is available here. It is automatically built and published each time a new version tag is added to the repo.

alt text

Origin

This library has been developed orginally by P.-A. Mudry for the PImp and inf1 courses given at the School of engineering HES-SO Valais//Wallis.

Compiling

For releasing a new version, once everything has been tested, locally run

  • UNIX-like (Linux, MacOS X, ...) : ./gradlew build
  • Windows : gradlew.bat build

results :

File Description
build/fungraphics-dev.jar The latest build of the library, constant name, useful for testing.
build/libs/fungraphics-VERSION.jar The same file with a versioned name.

How to release (and have a nice version number)

  1. git commit
  2. git tag -a MAJOR.MINOR.SUB -m "tag vMAJOR.MINOR.SUB"
  3. git push origin MAJOR.MINOR.SUB
  4. This commits everyhing and tags it adequately.
  5. When this has been done, you can then build the corresponding jar file with ./gradlew build for having the correct version number built by Maven. You can then draft a new release and upload the corresponding jar file from above in GitHub releases. Creating a tag triggers the documentation update. Voilà, you're all set !

Version numbers in Scala

The version numbering used in the file name and available using FunGraphics.version() is generated by inspecting the git state (see com.palantir.git-version for details). However, the commit should be tagged accordingly.

Here is an example : 1.5.7-3-g2aabbbf.dirty

  • 1.5.7 is the last tag
  • -3- we are 3 commits after the tag
  • g2aabbbf : git short hash
  • .dirty : some changes are not committed

fungraphics's People

Contributors

lordbaryhobal avatar pmudry avatar randomreaper avatar sdevenes avatar

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.