<commit_before>Chillin.js
==========
A layout engine on top of [impress.js](http://bartaz.github.io/impress.js/ "impress.js").

The global idea
---------------
Chillin.js provides a convenient way to position slides inside an impress.js presentation. It has two requirements: jQuery and impress.js (currently works with jQuery 1.9.1 and impress.js 0.5.3).

The problem to solve
--------------------
impress.js is a powerful way to convey ideas, nevertheless it can be a bit challenging to correctly position all your workflow.

For example, you can use impress.js to do impressive "combined" slides where you switch to an element of only one view at each slide. This is awesome, but two cases may occure:

* You may want to have two (or more) **sets of "combined" slides**, independent one from another.
* You may want to keep the basic-and-old-school "one slide per slide", to make it more clear: **one visible content per slide**.

In those two cases editing one single slide position may force you to update your whole presentation.

Moreover you may also, want to avoid positionning everything manually, anything simple would suit you.

How to use it?
--------------

### Simple setup
First you need to include `chillin.js` (the one in `bin`) and call it before calling impress.js. Like with impress.js, **those scripts should be right before the end of the page, before `</body>`**.

    <script src="./lib/jquery-1.9.1.min.js"></script>
    <script src="./lib/impress.js"></script>
    <script src="./lib/chillin.js"></script>
    <script>
    	$(document).ready(function() {
	        $(document).chillin();
        	impress().init();
    	});
    </script>
    
### Chillin options

The most interesting option that can be pass to chillin might be `layoutAlgorithm`, its value is defining **how to position slides by default** (if not positionned in another way). Its possible values are: `inspiral` (default), `outspiral`, and side to side like `bottomtoprightleft` and `leftrightbottomtop` (from left to right and bottom to top).

To make it clear, this is how `inspiral` is positionning the slides:
    
    -----------------<
    |
    | ------------<- |
    | |              |
    | |   <-------   |
    | |           |  |
    | |--------<--   ^
    |________________|
    
An exemple to avoid misunderstanding.
    
    <script>
    	$(document).ready(function() {
	        $(document).chillin({
	            layoutAlgorithm: 'outspiral'
	        });
        	impress().init();
    	});<commit_msg>Fixing typo in README.md about inspiral positionning<commit_after>Chillin.js
==========
A layout engine on top of [impress.js](http://bartaz.github.io/impress.js/ "impress.js").

The global idea
---------------
Chillin.js provides a convenient way to position slides inside an impress.js presentation. It has two requirements: jQuery and impress.js (currently works with jQuery 1.9.1 and impress.js 0.5.3).

The problem to solve
--------------------
impress.js is a powerful way to convey ideas, nevertheless it can be a bit challenging to correctly position all your workflow.

For example, you can use impress.js to do impressive "combined" slides where you switch to an element of only one view at each slide. This is awesome, but two cases may occure:

* You may want to have two (or more) **sets of "combined" slides**, independent one from another.
* You may want to keep the basic-and-old-school "one slide per slide", to make it more clear: **one visible content per slide**.

In those two cases editing one single slide position may force you to update your whole presentation.

Moreover you may also, want to avoid positionning everything manually, anything simple would suit you.

How to use it?
--------------

### Simple setup
First you need to include `chillin.js` (the one in `bin`) and call it before calling impress.js. Like with impress.js, **those scripts should be right before the end of the page, before `</body>`**.

    <script src="./lib/jquery-1.9.1.min.js"></script>
    <script src="./lib/impress.js"></script>
    <script src="./lib/chillin.js"></script>
    <script>
    	$(document).ready(function() {
	        $(document).chillin();
        	impress().init();
    	});
    </script>
    
### Chillin options

The most interesting option that can be pass to chillin might be `layoutAlgorithm`, its value is defining **how to position slides by default** (if not positionned in another way). Its possible values are: `inspiral` (default), `outspiral`, and side to side like `bottomtoprightleft` and `leftrightbottomtop` (from left to right and bottom to top).

To make it clear, this is how `inspiral` is positionning the slides:
    
    -----------------<
    |
    | ------------<- |
    | |              |
    | |   <-------   |
    | |           |  |
    | |-------->--   ^
    |________________|
    
An exemple to avoid misunderstanding.
    
    <script>
    	$(document).ready(function() {
	        $(document).chillin({
	            layoutAlgorithm: 'outspiral'
	        });
        	impress().init();
    	});
{'fraction_non_alphanumeric': 0.14246196403872752, 'fraction_numerical': 0.0035566093657379964, 'mean_word_length': 2.694890510948905, 'pattern_counts': {'":': 0, '<': 30, '<?xml version=': 0, '>': 24, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '436740', 'n_tokens_mistral': 1410, 'n_tokens_neox': 1359, 'n_words': 588}