cubing.js icon indicating copy to clipboard operation
cubing.js copied to clipboard

Add better usage instructions to documentation

Open leftbones opened this issue 4 years ago • 1 comments

I used JSSS years ago but now that points to this as it's been deprecated.

There doesn't appear to be any clear way to actually install, import, and use this in a standard HTML/Javascript environment. All I'm looking to do is generate scrambles from my main.js, yet attempting to import anything throws all sorts of nonsensical errors.

Please simplify usage for those who can't/don't use NPM.

leftbones avatar Dec 06 '21 20:12 leftbones

Apologies for the delay, I missed the notification for this issue until now.

https://github.com/cubing/jsss#%EF%B8%8F-javascript-solverscrambler-suite-%EF%B8%8F includes this sample snippet:

<script type="module">
  import { randomScrambleForEvent } from "https://cdn.cubing.net/js/cubing/scramble";

  const scramble = await randomScrambleForEvent("333");
  scramble.log();
</script>

https://js.cubing.net/cubing/scramble/ also includes more information.

Is that sufficient for you?

lgarron avatar Dec 22 '21 11:12 lgarron