erniemac / bootstrap-tour

Quick and easy product tours with Twitter Bootstrap Popovers

Bootstrap Tour

Quick and easy way to build your product tours with Twitter Bootstrap Popovers.

Compatible with Bootstrap >= 2.3.0

Demo and Documentation

http://bootstraptour.com

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Feel free to contribute with pull requests, bug reports or enhancement suggestions.

We use Grunt and Jasmine. Both make your lives easier ;)

How to build/develop

Files to be developed are located under ./src/ Compiled sources are then automatically put under ./build/ (and ./test/)

Installing the dependencies

npm install
gem install jekyll

Running Grunt tasks

// Start a server and run the demo page
grunt
grunt go
// Compile all sources
grunt build
// Compile all sources and run the tests
grunt test
// Automatically release a new version
grunt release // patch release
grunt release:minor // minor release
grunt release:major // major release

Check Gruntfile.coffee for more infos.

License

Code licensed under the Apache License v2.0. Documentation licensed under CC BY 3.0.