From 15be8bb36cd2cdc7338622d250da996bbbad32a0 Mon Sep 17 00:00:00 2001 From: charafau Date: Wed, 19 Oct 2016 21:49:53 +0900 Subject: [PATCH] Upgraded project docs to include -I incremental switch --- README.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 0beec40a56..b4f1d5469d 100644 --- a/README.md +++ b/README.md @@ -19,29 +19,15 @@ This site uses a Jekyll, a Ruby framework. You'll need Ruby and Bundler installe cd into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./vendor/bundle`. -Start the server in the context of the bundle: +Start the server in the context of the bundle (use `-I` for incremental builds): - bundle exec jekyll serve + bundle exec jekyll serve -I -The generated site is available at `http://localhost:4000` - -If you add `--watch` at the end of the command line above, Jekyll will automatically watch for changes on the filesystem, and regenerate the site. It can take a few minutes for your changes to appear. Watch Jekyll's output. When you start up you'll see this: - - $ bundle exec jekyll serve --watch - Configuration file: /Users/ben/src/scala.github.com/_config.yml - Source: /Users/ben/src/scala.github.com - Destination: /Users/ben/src/scala.github.com/_site - Generating... - done. - Auto-regeneration: enabled for '/Users/ben/src/scala.github.com' +`It might take around 5 minutes at first but incremental compilations will be fast.` -When you change a file, this output will tell you that jekyll is regenerating. It's not done until it says `done.` +The generated site is available at `http://localhost:4000` - Server running... press ctrl-c to stop. - Regenerating: 1 files at 2014-11-29 09:19:04 ...done. - Regenerating: 3 files at 2014-11-29 09:21:39 ...done. - Regenerating: 2 files at 2014-11-29 09:25:10 ...done. - Regenerating: 2 files at 2014-11-29 09:27:49 +If you add `--watch` at the end of the command line above, Jekyll will automatically watch for changes on the filesystem, and regenerate the site. If you get `incompatible encoding` errors when generating the site under Windows, then ensure that the console in which you are running jekyll can work with UTF-8 characters. As described in the blog @@ -61,4 +47,3 @@ There's a free markdown editor for OSX called [Mou](http://25.io/mou/). It's qui ## License ## All documentation contained in this repository is licensed by EPFL under a Creative Commons Attribution-Share Alike 3.0 Unported license ("CC-BY-SA"), unless otherwise noted. By submitting a "pull request," or otherwise contributing to this repository, you implicitly agree to license your contribution under the above CC-BY-SA license. The source code of this website is licensed to EPFL under the [Scala License](http://www.scala-lang.org/node/146), unless otherwise noted. -