There are several ways to install Cirsim:
- Using the NPM Package Manager
- Using from a content distribution network (CDN)
- Using with webpack
- Using with CourseLib
Using the NPM Package Manager
Installing Cirsim using npm:
npm install cirsim --save
After installation, Cirsim is available using this script tag (assuming the home directory):
<script src="node_modules/cirsim/dist/cirsim.min.js"></script>
Using from a content distribution network (CDN)
Cirsim is available on the unpkg.com CDN. The HTML to load Cirsim from a CDN is:
<script src="https://unpkg.com/cirsim/dist/cirsim.min.js"></script>
Using with webpack
Documentation is pending. Using Cirsim with webpack is an advanced activity, since the webpack project must be configured properly to build Cirsim.
Using with CourseLib
The CourseLib course website framework provides an easy way to install and use Cirsim with features including simple PHP support, support for saving files in the CourseLib file system, quizzes that utilize Cirsim tests, and more.
See the CourseLib site for details on installing a basic site. The minimum requirement for Cirsim is cl/site only, though other options allow for more powerful capabilities. Details on using Cirsim with CourseLib are included on that site.