From d30cbb98edb58ba2a28c2fc4a1df5f13bcfb4888 Mon Sep 17 00:00:00 2001 From: Greg Wilson Date: Tue, 23 Feb 2016 15:09:11 -0500 Subject: [PATCH] Taking out preview instructions because they don't work --- FAQ.md | 2 -- README.md | 38 +++++++++++++++++--------------------- 2 files changed, 17 insertions(+), 23 deletions(-) diff --git a/FAQ.md b/FAQ.md index 5982dad..e921530 100644 --- a/FAQ.md +++ b/FAQ.md @@ -37,8 +37,6 @@ Go ahead, but you *must* have the variables described in [CUSTOMIZATION.md](CUSTOMIZATION.md). - Please make sure to run `tools/check.py` after adding or changing variables - to make sure that our main website will understand your changes. * *What is the "Windows installer"?* diff --git a/README.md b/README.md index 5f4560f..9d24f0c 100644 --- a/README.md +++ b/README.md @@ -101,8 +101,7 @@ please [get in touch](#getting-and-giving-help). its GitHub Pages website is at `http://your_username.github.io/YYYY-MM-DD-site`. 4. When you are done editing, - you can preview your website. - Again, + you can view your website: if your repository is `https://github.com/your_username/YYYY-MM-DD-site`, its website will be `http://your_username.github.io/YYYY-MM-DD-site`. @@ -116,27 +115,22 @@ The following steps are only necessary if you want to run the website locally on ## Checking Your Changes -**Note:** to check your changes you need some softwares -that are describe at [Installing Software session](#installing-software). +1. To check your changes on your desktop you need some softwares + described at [Installing Software session](#installing-software). + This may require some work to set up, + so feel free to preview by pushing to the website. -No matter how you edit `index.html`, you should: +2. For some links to work properly, + particularly the link to your workshop's Eventbrite registration page, + you must view `_site/index.html` using an HTTP server. + If you have Jekyll installed, + you can do this by running: -1. Check your changes by running `tools/check.py` at the command line - from the root directory of your repository. - -2. Preview your changes by running `tools/preview` and looking at `_site/index.html`. - -For some links to work properly, -particularly the link to your workshop's Eventbrite registration page, -you must view `_site/index.html` using an HTTP server. -If you have Jekyll installed, -you can do this by running: - -~~~ -$ jekyll server -d _site -~~~ + ~~~ + $ jekyll server -d _site + ~~~ -and going to http://localhost:4000. + and going to http://localhost:4000. ## Installing Software @@ -184,7 +178,9 @@ you must install the software described below. the default Redcarpet, because Kramdown handles Markdown inside HTML blocks. - Note: You may need to specify the version of gem to use for installation (if you have multiple versions of Ruby installed). For example for version 2.0 you could use: + Note: you may need to specify the version of gem to use for installation + if you have multiple versions of Ruby installed. + For example for version 2.0 you could use: ~~~ $ gem2.0 install github-pages