Notorious Public Menace

    rectangular

    1.0.1 • Public • Published

    rectangular

    Simple rectangle and point classes

    Try the demo. (This demo just shows one or two features; it's really just a test harness.)

    API documentation

    Detailed API docs can be found here.

    Regarding submodules

    This repo has a git submodule, which on the remote appears as a folder that is actually a pointer to another repo, similar to a linux symbolic link. On your local it is a normal folder with a copy of that other repo's contents.

    Cloning

    When cloning this repo keep in mind that the jsdoc-template folder is a submodule. Therefore, be sure to give the --recurse-submodules option to checkout the contents of the submodule:

    $ git clone --recurse-submodules https://github.com/openfin/repo-name-goes-here.git

    If you forget, you can still do it (soon) after cloning as a separate command:

    $ git clone https://github.com/openfin/repo-name-goes-here.git
    $ git submodule update --init --recursive

    Re-purposing for a new repo

    Openfin developers: If you want to use this build template for a new repo, to continue to make use of the symbolic link to the shared jsdoc-template folder, issue the following commands:

    $ rm -drf jsdoc-template/
    $ rm .gitmodules
    $ git submodule add https://github.com/openfin/jsdoc-template jsdoc-template

    These changes will then need to be committed.

    Keywords

    none

    Install

    npm i rectangular

    DownloadsWeekly Downloads

    80

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • joneit