JSPM

cubing

0.16.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 529
  • Score
    100M100P100Q107493F
  • License GPL-3.0-or-later

A collection of Javascript cubing libraries.

Package Exports

  • cubing
  • cubing/alg
  • cubing/bluetooth
  • cubing/kpuzzle
  • cubing/protocol
  • cubing/puzzle-geometry
  • cubing/puzzles
  • cubing/stream
  • cubing/twisty

Readme

cubing.js

make test
make build

cubing.js is a collection of Javascript libraries, still under development.

Documentation

Documentation is at js.cubing.net/cubing/.
The source for the documentation site is currently inside the docs folder of this repository.

Development

git clone https://github.com/cubing/cubing.js && cd cubing.js
npm install
make dev

This should open http://localhost:3333/ automatically.

License

This project is licensed under the GPL license (version 3 or later). This means that this library is free to use, although you must publish any code that uses it (e.g. also put it on GitHub). See the full license for exact details.

We've selected this license in order to encourage the cubing community to work on software in a way so that everyone can contribute and extend each other's work.