describing new presentation sizing logic in readme
authorHakim El Hattab <hakim.elhattab@gmail.com>
Sun, 3 Feb 2013 06:21:55 +0000 (01:21 -0500)
committerHakim El Hattab <hakim.elhattab@gmail.com>
Sun, 3 Feb 2013 06:21:55 +0000 (01:21 -0500)
README.md

index ea6be5e7f17aa6b5553c3b1ddf0344461565ec54..7f20a05969dd4d2780dc855571cee6f12bcf6bcf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -56,19 +56,6 @@ At the end of your page you need to initialize reveal by running the following c
 ```javascript
 Reveal.initialize({
 
-       // The "normal" size of the presentation, aspect ratio will be preserved
-       // when the presentation is scaled to fit different resolutions. Can be
-       // specified using percentage units.
-       width: 960,
-       height: 700,
-
-       // Factor of the display size that should remain empty around the content
-       margin: 0.1,
-
-       // Bounds for smallest/largest possible scale to apply to content
-       minScale: 0.2,
-       maxScale: 1.4,
-
        // Display controls in the bottom right corner
        controls: true,
 
@@ -112,6 +99,35 @@ Reveal.initialize({
 
 Note that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`.
 
+
+### Presentation Size
+
+All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport. 
+
+See below for a list of configuration options related to sizing, including default values:
+
+```javascript
+Reveal.initialize({
+       
+       ...
+       
+       // The "normal" size of the presentation, aspect ratio will be preserved
+       // when the presentation is scaled to fit different resolutions. Can be
+       // specified using percentage units.
+       width: 960,
+       height: 700,
+       
+       // Factor of the display size that should remain empty around the content
+       margin: 0.1,
+       
+       // Bounds for smallest/largest possible scale to apply to content
+       minScale: 0.2,
+       maxScale: 1.0
+       
+});
+```
+
+
 ### Dependencies
 
 Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example: