Merge pull request #4 from gdiminneapolis/windowize

Windowize

Author: tamouse

DETAILS-README.md

@@ -0,0 +1,6 @@
+
+## Creating a new remote repository
+
+* On the Mac, run `hub create`. If you don't have `hub` installed, install it.
+
+* Otherwise follow the direction at Github for [how to create a repository](https://help.github.com/articles/creating-a-new-repository/).

README.md

@@ -33,7 +33,7 @@ installed:
 gem install bundler
 ```
 
-* [Hub](https://github.com/github/hub#installation)
+* [Hub](https://github.com/github/hub#installation) if you are on a Mac
 
 
 
@@ -49,16 +49,13 @@ gem install bundler
 
 5. Change into the new directory.
 
-7. Run the setup script: `./setup.sh`
+7. Run the setup script: `./setup.sh` on a Mac or Linux. We have to do something else on Windows.
 
-8. Create your github repository for this repo: `hub create`. If you
-   don't have `hub` installed, install it. If you can't, follow the
-   direction at Github for
-   [how to create a repository](https://help.github.com/articles/creating-a-new-repository/).
+8. Create your github repository for this repo.
 
-9. Do the initial git dance: `git add --all && git commit -m "initial commit" && git push -u origin master`
+9. Add and commit all the files to master. Push to the remote when satisfied.
 
-10. Right now, create a new branch for working: `git checkout -b dev && git push -u origin dev`
+10. Right now, create a new branch for working on the slides and push that to the remote as well.
 
 ### Keep Git Up to Date
 
@@ -105,6 +102,8 @@ doing this, discuss this with at the organization.
 
 ## Spin up the Jekyll Server
 
+**NOTE** that the jekyll `--watch` option does **not** work on Windows. We have to do something else to make a convenient watching/viewing-as-you-save-changes thing.
+
 Everything should be good to go, now, and you can start up the Jekyll
 development server to show the slides while you create them.
 
@@ -140,7 +139,7 @@ For example, the introduction slide is:
 `_slides/99.99.fin.html`.
 
 A very good practice is to leave gaps in the sequence number to make
-it easy to rearrange slides if you want, or insert conent as you'd
+it easy to rearrange slides if you want, or insert content as you'd
 like.
 
 If you need more than 100 sections or more than 100 slides per
@@ -308,7 +307,7 @@ Non-commercial 3.0 Unported (CC BY-NC 3.0)
 
 * The
   [Jekyll team](https://github.com/jekyll/jekyll/graphs/contributors),
-  especiall parkr
+  especially parkr
 
 * [Hakim El Hattab](https://github.com/hakimel), creator of
   `reveal.js`

Rakefile

@@ -3,13 +3,13 @@ require 'erb'
 
 desc "jekyll server with full build"
 task :server do |t|
-  sh "bin/jekyll serve --port #{ENV["JEKYLL_PORT"]}"
+  sh "bundle exec jekyll serve --port #{ENV["JEKYLL_PORT"]}"
 end
 task :default => :server
 
 desc "jekyll server with incremental build"
 task :server_inc do |t|
-  sh "bin/jekyll serve --incremental --port #{ENV["JEKYLL_PORT"]}"
+  sh "bundle exec jekyll serve --incremental --port #{ENV["JEKYLL_PORT"]}"
 end
 
 desc "build and push to staging"
@@ -19,7 +19,7 @@ namespace :stage do
   desc "build staging"
   task :build do |t|
     puts "Staging baseurl: #{jekyll_staging_config["baseurl"]}"
-    sh "bin/jekyll build --config=_config.yml,_staging.yml"
+    sh "bundle exec jekyll build --config=_config.yml,_staging.yml"
   end
   desc "push staging"
   task :push do |t|
@@ -38,7 +38,7 @@ task :publish => ['publish:build', 'publish:push']
 namespace :publish do
   desc "build production"
   task :build do |t|
-    sh "bin/jekyll build --config=_config.yml,_publish.yml"
+    sh "bundle exec jekyll build --config=_config.yml,_publish.yml"
   end
   desc "push to production"
   task :push do |t|

WINDOWS-README.md

@@ -0,0 +1,11 @@
+# Instructions for Windows Users
+
+These are additional instructions for those of you who run on Windows, and the commands don't quite work.
+
+## Creating the new slide repository on Github
+
+While Mac users get to work with `hub`, Windows users have to do things the old-fashioned way by creating the empty repository on GitHub and setting the remote origin by hand.
+
+GUI tools such as Github Desktop for Windows or Sourcetree can help if you are uncomfortable using the GitBash shell.
+
+See [Create a Repo](https://help.github.com/articles/create-a-repo/) on GitHub for help with creating the remote repository.

_config.yml

@@ -18,8 +18,6 @@ contact:
   github: "gdiminneapolis"
 
 
-reveal_path: "/reveal.js"
-
 # There are a handful of styles available with reveal. They can be found in the
 # reveal.js/css/themes folder, and include:
 #
@@ -35,6 +33,8 @@ style: gdidefault
 collections:
   - slides
 
+# If you create other files or folders that you do NOT want as part of the slide presentation
+# include them in this list.
 exclude:
   - bin
   - CONTRIBUTOR_COVENANT.md
@@ -46,5 +46,6 @@ exclude:
   - README.md
 
 # Don't change these. Change values in _staging.yml and _publish.yml appropriately.
+reveal_path: "/reveal.js"
 baseurl: ""
 url: ""