Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 81 lines (55 sloc) 2.962 kB
642e93e @fczbkk updated dev documentation for Mac OS X Mavericks users
fczbkk authored
1 # Bootstrap Tour
848327f @LostCrew substituted badges in README
LostCrew authored
2 [![Build Status](http://img.shields.io/travis/sorich87/bootstrap-tour.svg?style=flat)](https://travis-ci.org/sorich87/bootstrap-tour)
3 [![Dependency Status](http://img.shields.io/david/sorich87/bootstrap-tour.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour)
4 [![devDependency Status](http://img.shields.io/david/dev/sorich87/bootstrap-tour/dev-status.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour#info=devDependencies)
5 [![NPM Version](http://img.shields.io/npm/v/bootstrap-tour.svg?style=flat)](https://www.npmjs.org/)
ba0579c @emmenko Add travis-ci configuration
emmenko authored
6
fa4c619 @cvrebert "Twitter Bootstrap" is now simply Bootstrap
cvrebert authored
7 Quick and easy way to build your product tours with Bootstrap Popovers.
206e43e @sorich87 Added method to restart the tour
authored
8
e38b3fc @sorich87 Make the docs multipage
authored
9 *Compatible with Bootstrap >= 2.3.0*
6aae278 @LostCrew refined doc and readme
LostCrew authored
10
e38b3fc @sorich87 Make the docs multipage
authored
11 ## Demo and Documentation
168bfc6 @sorich87 Changed demo URL
authored
12 [http://bootstraptour.com](http://bootstraptour.com)
135f938 @LostCrew added new stuff to readme file
LostCrew authored
13
e38b3fc @sorich87 Make the docs multipage
authored
14 ## Contributing
49b1c49 @LostCrew removed grunt traces
LostCrew authored
15 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/).
6f331d4 @emmenko Update documentation
emmenko authored
16
135f938 @LostCrew added new stuff to readme file
LostCrew authored
17 Feel free to contribute with pull requests, bug reports or enhancement suggestions.
18
eef4bab @marclaporte Start the formal process to change the license from Apache to MIT
marclaporte authored
19 The license of Bootstrap Tour is Apache for now. However, the project intends to move to the MIT license like Bootstrap has. All the biggest contributors are ok with the change and thus, all new contributions as of 2015-07-22 are to be with the MIT license. And once all previous contributors have approved the change (or their code has been removed), the project will become licensed MIT. Please see: https://github.com/sorich87/bootstrap-tour/issues/257
20
21
aea8e48 @dannon Fix jasmine URL in README.
dannon authored
22 We use [Gulp](http://gulpjs.com/) and [Jasmine](http://jasmine.github.io/). Both make your life easier ;)
745e791 @emmenko Improve README and cleanup unused files
emmenko authored
23
49b1c49 @LostCrew removed grunt traces
LostCrew authored
24 ### Develop
6ddeda9 @LostCrew Revert "revisioned readme"
LostCrew authored
25
49b1c49 @LostCrew removed grunt traces
LostCrew authored
26 Files to be developed are located under `./src/`.
27 Compiled sources are then automatically put under `./build/`, `./test/` and `./docs/`.
e38b3fc @sorich87 Make the docs multipage
authored
28
49b1c49 @LostCrew removed grunt traces
LostCrew authored
29 #### Requirements
745e791 @emmenko Improve README and cleanup unused files
emmenko authored
30
bc4346e @mlissner Updates the readme to include the dependencies for the dependencies, …
mlissner authored
31 To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, npm, and grunt's command line runner:
32
49b1c49 @LostCrew removed grunt traces
LostCrew authored
33 ##### Linux
34f52ca @sorich87 Add Node and Ruby installation instructions for Mac in readme
authored
34
bc4346e @mlissner Updates the readme to include the dependencies for the dependencies, …
mlissner authored
35 ```bash
49b1c49 @LostCrew removed grunt traces
LostCrew authored
36 $ sudo apt-get install ruby
37 $ sudo apt-get install ruby-dev
38 $ sudo apt-get install npm
39 $ sudo apt-get install nodejs-legacy
bc4346e @mlissner Updates the readme to include the dependencies for the dependencies, …
mlissner authored
40 ```
41
49b1c49 @LostCrew removed grunt traces
LostCrew authored
42 ##### Mac OS X
bc4346e @mlissner Updates the readme to include the dependencies for the dependencies, …
mlissner authored
43
745e791 @emmenko Improve README and cleanup unused files
emmenko authored
44 ```bash
34f52ca @sorich87 Add Node and Ruby installation instructions for Mac in readme
authored
45 ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
46 \curl -L https://get.rvm.io | bash
47 rvm install ruby-2.1.1
48 brew install node
49 ```
50
49b1c49 @LostCrew removed grunt traces
LostCrew authored
51 ##### Development requirements
34f52ca @sorich87 Add Node and Ruby installation instructions for Mac in readme
authored
52
53 ```bash
c4c7d46 @LostCrew ignored docs file, adjusted travis config file, fixed wrong command i…
LostCrew authored
54 $ npm install -g gulp
49b1c49 @LostCrew removed grunt traces
LostCrew authored
55 $ npm install
56 $ gem install jekyll
745e791 @emmenko Improve README and cleanup unused files
emmenko authored
57 ```
58
bc4346e @mlissner Updates the readme to include the dependencies for the dependencies, …
mlissner authored
59 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.
642e93e @fczbkk updated dev documentation for Mac OS X Mavericks users
fczbkk authored
60
49b1c49 @LostCrew removed grunt traces
LostCrew authored
61 #### Gulp usage
62
63 Run gulp and start to develop with ease:
64
65 ```bash
66 $ gulp
67 $ gulp dist
68 $ gulp test
69 $ gulp docs
70 $ gulp clean
71 $ gulp server
39fe590 @sorich87 Add bump task
authored
72 $ gulp bump --type minor (major.minor.patch)
6f331d4 @emmenko Update documentation
emmenko authored
73 ```
74
49b1c49 @LostCrew removed grunt traces
LostCrew authored
75 Check `gulpfile.coffee` to know more.
e38b3fc @sorich87 Make the docs multipage
authored
76
77 ## License
78
135f938 @LostCrew added new stuff to readme file
LostCrew authored
79 Code licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
80 Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
Something went wrong with that request. Please try again.