diff --git a/README.md b/README.md index 9b377fb7..c521b905 100644 --- a/README.md +++ b/README.md @@ -758,7 +758,7 @@ Some reveal.js features, like external markdown, require that presentations run 4. Clone the reveal.js repository ``` -$ git clone git@github.com:hakimel/reveal.js.git +$ git clone https://github.com/hakimel/reveal.js.git ``` 5. Navigate to the reveal.js folder @@ -790,18 +790,16 @@ You can change the port by using `grunt serve --port 8001`. ### Contributing -Please keep the [issue tracker](github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue. +Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue. If you have personal support questions use [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js). #### Pull requests -- Should follow the coding style +- Should follow the coding style of the file you work in, most importantly: - Tabs to indent - Single-quoted strings - - No space between function name and opening argument parenthesis - - One space after opening and before closing parenthesis - Should be made towards the **dev branch** - Should be submitted from a feature/topic branch (not your master) diff --git a/css/theme/README.md b/css/theme/README.md index 28ded299..8237586e 100644 --- a/css/theme/README.md +++ b/css/theme/README.md @@ -2,7 +2,7 @@ Themes are written using Sass to keep things modular and reduce the need for repeated selectors across files. Make sure that you have the reveal.js development environment including the Grunt dependencies installed before proceding: https://github.com/hakimel/reveal.js#full-setup - +You also need to install Ruby and then Sass (with `gem install sass`). ## Creating a Theme @@ -21,3 +21,5 @@ This is where you override the default theme. Either by specifying variables (se 4. **Include [/css/theme/template/theme.scss](https://github.com/hakimel/reveal.js/blob/master/css/theme/template/theme.scss)** The template theme file which will generate final CSS output based on the currently defined variables. + +When you are done, run `grunt themes` to compile the Sass file to CSS and you are ready to use your new theme.