Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
Conflicts:
	bower.json
	package.json
  • Loading branch information
Alexerson committed Nov 18, 2014
2 parents 25590bc + 38d67ab commit f5b5064
Show file tree
Hide file tree
Showing 67 changed files with 3,636 additions and 14,011 deletions.
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
.grunt
docs-build
bower_components
node_modules
bower_components
bootstrap-tour.sublime-project
bootstrap-tour.sublime-workspace
npm-debug.log
test/spec
test
docs
_SpecRunner.html
*.DS_Store
smart.lock
7 changes: 5 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
language: node_js
node_js:
- "0.8"
- "0.10"
before_install:
- "export DISPLAY=:99.0"
- "sh -e /etc/init.d/xvfb start"
before_script:
- npm install -g grunt-cli
- npm install -g gulp
- npm install -g bower
- bower install
branches:
Expand Down
232 changes: 0 additions & 232 deletions Gruntfile.coffee

This file was deleted.

79 changes: 50 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Bootstrap Tour
[![Build Status](http://img.shields.io/travis/sorich87/bootstrap-tour.svg)](https://travis-ci.org/sorich87/bootstrap-tour)
[![Dependency Status](https://david-dm.org/sorich87/bootstrap-tour.svg?theme=shields.io)](https://david-dm.org/sorich87/bootstrap-tour)
[![devDependency Status](https://david-dm.org/sorich87/bootstrap-tour/dev-status.svg?theme=shields.io)](https://david-dm.org/sorich87/bootstrap-tour#info=devDependencies)
[![NPM Version](http://img.shields.io/npm/v/bootstrap-tour.svg)](https://www.npmjs.org/)
[![Build Status](http://img.shields.io/travis/sorich87/bootstrap-tour.svg?style=flat)](https://travis-ci.org/sorich87/bootstrap-tour)
[![Dependency Status](http://img.shields.io/david/sorich87/bootstrap-tour.svg?style=flat)](https://david-dm.org/sorich87/bootstrap-tour)
[![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)
[![NPM Version](http://img.shields.io/npm/v/bootstrap-tour.svg?style=flat)](https://www.npmjs.org/)

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

Expand All @@ -12,43 +12,64 @@ Quick and easy way to build your product tours with Bootstrap Popovers.
[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 [Grunt](http://gruntjs.com/).
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 [Grunt](http://gruntjs.com/) and [Jasmine](http://pivotal.github.io/jasmine/). Both make your lives easier ;)
We use [Gulp](http://gulpjs.com/) and [Jasmine](http://pivotal.github.io/jasmine/). Both make your life easier ;)

### How to build/develop
### Develop

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

#### Installing the dependencies
#### Requirements

To begin, you need a few standard dependencies installed. These commands will install ruby, gem, node, npm, and grunt's command line runner:

##### Linux

```bash
$ sudo apt-get install ruby
$ sudo apt-get install ruby-dev
$ sudo apt-get install npm
$ sudo apt-get install nodejs-legacy
```

##### Mac OS X

```bash
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"
\curl -L https://get.rvm.io | bash
rvm install ruby-2.1.1
brew install node
```

##### Development requirements

```bash
npm install
gem install jekyll
$ npm install -g gulp
$ npm install
$ gem install jekyll
```

Note 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.

#### Running Grunt tasks

```javascript
// 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
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 `Gruntfile.coffee` for more infos.
Check `gulpfile.coffee` to know more.

## License

Expand Down
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
markdown: rdiscount
permalink: pretty
source: ./docs
destination: ./docs-build
source: ./src/docs
destination: ./docs
encoding: UTF-8
7 changes: 5 additions & 2 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bootstrap-tour",
"version": "0.9.4",
"version": "0.10.1",
"main": [
"./build/js/bootstrap-tour.js",
"./build/js/bootstrap-tour-standalone.js",
Expand All @@ -12,6 +12,9 @@
"jquery": ">=1.9.0"
},
"devDependencies": {
"bootstrap": "~3.1.1"
"html5shiv": "~3.7.2",
"jquery": "~2.1.1",
"bootstrap": "~3.2.0",
"blueimp-md5": "~1.1.0"
}
}
Loading

0 comments on commit f5b5064

Please sign in to comment.