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

## Demo and Documentation ##
[http://bootstraptour.com](http://bootstraptour.com)

## TODO ##
- Add the smooth scrolling when the popover is outside the viewport
- Define an appropriate tag + milestone system
- Integrate Travis build

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

_We use [Grunt](http://gruntjs.com/) as our Task Runner, which makes your life way easier ;)_

### Run / Develop ###

#### Install the dependencies ####

```bash
npm install -d
```

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

#### List of commands ####

Now you can perform a series of predefined Tasks by executing `grunt <task>:<target>`

```javascript
// clean all the 'build' directories, or specify a single target
clean
clean:default
clean:test

// compile the coffeescripts into the 'build' directories, or specify a single target
coffee
coffee:default
coffee:test
coffee:doc

// compile the less file into the 'build' directory with a minified version, or specify a single target
less
less:default
less:min

// minify the javascripts in the 'build' directory
uglify

// watch for changes of the coffeescripts (main and spec) and execute the assigned tasks, or specify a single target
watch
watch:default // tasks: clean:default, coffee:default, uglify
watch:test // tasks: clean:test, coffee:test, jasmine
watch:doc // tasks: coffee:doc (with livereload)

// run the jasmine specs headlessly through 'phantomjs'
jasmine

// copy sources into doc assets
copy

// small server to serve the static files
connect

// open automatically the browser to the port defined in connect options
open
```

There are also some _aliases_ for multiple tasks

```javascript
// alias for watch:default
grunt
grunt default

// alias for connect, open, watch:doc
grunt run

// alias for clean:default, coffee:default, coffee:doc, less, uglify, copy
grunt build

// alias for clean:test, coffee:test, jasmine
grunt test
```

#### Live reload ####

Running `grunt run` will start a small server on port `3000` and opens the browser to the webpage. It will also start watching for changes in the `index.coffee` which will trigger then live reloading of the page in the browser.


## License ##
Code licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
Well, the same licenses as Bootstrap. We are lazy! ;)<commit_msg>Revert "revisioned readme"<commit_after>Quick and easy way to build your product tours with Twitter Bootstrap Popovers.

## Demo and Documentation ##
[http://bootstraptour.com](http://bootstraptour.com)

## TODO ##
- Add the smooth scrolling when the popover is outside the viewport
- Define an appropriate tag + milestone system
- Integrate Travis build

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

_We use [Grunt](http://gruntjs.com/) as our Task Runner, which makes your life way more easy ;)_


### How to run/develop

Install the dependencies

```bash
npm install -d
```

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

Now you can perform a series of predefined Tasks by executing `grunt <task>:<target>`

```javascript
// clean all the 'build' directories, or specify a single target
clean
clean:default
clean:test

// compile the coffeescripts into the 'build' directories, or specify a single target
coffee
coffee:default
coffee:test
coffee:doc

// compile the less file into the 'build' directory with a minified version, or specify a single target
less
less:default
less:min

// minify the javascripts in the 'build' directory
uglify

// watch for changes of the coffeescripts (main and spec) and execute the assigned tasks, or specify a single target
watch
watch:default // tasks: clean:default, coffee:default, uglify
watch:test // tasks: clean:test, coffee:test, jasmine
watch:doc // tasks: coffee:doc (with livereload)

// run the jasmine specs headlessly through 'phantomjs'
jasmine

// copy sources into doc assets
copy

// small server to serve the static files
connect

// open automatically the browser to the port defined in connect options
open
```

There are also some _aliases_ for multiple tasks

```javascript
// alias for watch:default
grunt
grunt default

// alias for connect, open, watch:doc
grunt run

// alias for clean:default, coffee:default, coffee:doc, less, uglify, copy
grunt build

// alias for clean:test, coffee:test, jasmine
grunt test
```

### Live reload

Running `grunt run` will start a small server on port `3000` and opens the browser to the webpage. It will also start watching for changes in the `index.coffee` which will trigger then live reloading of the page in the browser.


## License ##
Code licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
Documentation licensed under [CC BY 3.0](http://creativecommons.org/licenses/by/3.0/).
Well, the same licenses as Bootstrap. We are lazy! ;)
{'fraction_non_alphanumeric': 0.09433962264150944, 'fraction_numerical': 0.004528301886792453, 'mean_word_length': 4.37082066869301, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4949812', 'n_tokens_mistral': 1549, 'n_tokens_neox': 1475, 'n_words': 681}