1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# Bootstrap Tour
[](https://travis-ci.org/sorich87/bootstrap-tour)
[](https://david-dm.org/sorich87/bootstrap-tour)
[](https://david-dm.org/sorich87/bootstrap-tour#info=devDependencies)
[](https://www.npmjs.org/)
Quick and easy way to build your product tours with Bootstrap Popovers.
*Compatible with Bootstrap >= 2.3.0*
## Demo and Documentation
[http://bootstraptour.com](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 [Gulp](http://gulpjs.com/).
Feel free to contribute with pull requests, bug reports or enhancement suggestions.
We use [Gulp](http://gulpjs.com/) and [Jasmine](http://jasmine.github.io/). Both make your life easier ;)
### Develop
Files to be developed are located under `./src/`.
Compiled sources are then automatically put under `./build/`, `./test/` and `./docs/`.
#### Requirements
To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, yarn, and gulp's command line runner:
##### Debian/Ubuntu Linux
```bash
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt-get update && sudo apt-get install ruby-full yarn
```
##### Mac OS X
```bash
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew install ruby yarn
```
##### Development requirements
```bash
$ yarn global add gulp-cli
$ yarn
$ gem install jekyll
```
For Mac OS X Mavericks (10.9) users: You will need to [jump through all these hoops](http://dean.io/setting-up-a-ruby-on-rails-development-environment-on-mavericks/) before you can install Jekyll.
#### Gulp usage
Run gulp and start to develop with ease:
```bash
$ gulp
$ gulp dist
$ gulp test
$ gulp docs
$ gulp clean
$ gulp server
$ gulp bump --type minor (major.minor.patch)
```
Check `gulpfile.coffee` to know more.
## License
Code licensed under the [MIT license](https://opensource.org/licenses/MIT).
Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
|
