aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2015-07-12 02:46:41 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2015-07-12 02:46:41 +0300
commitc7884906ab57d5c9e6f98de923e647b6e890c941 (patch)
tree9108adc890a38a1a0d7ad3e7f17611506a8d8a75
parentbump dependencies (diff)
downloadegor-tensin.github.io-c7884906ab57d5c9e6f98de923e647b6e890c941.tar.gz
egor-tensin.github.io-c7884906ab57d5c9e6f98de923e647b6e890c941.zip
README update
Diffstat (limited to '')
-rw-r--r--README.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/README.md b/README.md
index 500807e..1a8e6c6 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
# Egor Tensin
-This is my website hosted on [GitHub Pages](https://pages.github.com) at https://egor-tensin.github.io/.
+This is my website hosted on [GitHub Pages](https://pages.github.com) at
+https://egor-tensin.github.io/.
## Installation
-[Jekyll](http://jekyllrb.com/) is used to build a set of static HTML pages from a collection of templates and resources.
-Jekyll doesn't support Windows, however at the moment of writing one can get it to work using the excellent tutorial at http://jekyll-windows.juthilo.com/.
+[Jekyll](http://jekyllrb.com/) is used to build a set of static HTML pages from
+a collection of templates and resources.
+Jekyll doesn't support Windows, however at the moment of writing one can get it
+to work using the excellent tutorial at http://jekyll-windows.juthilo.com/.
I'm using [Bundler](http://bundler.io/) to set up a development environment.
-After the `bundler` gem is installed, project dependencies can be installed by running
+After the `bundler` gem is installed, project dependencies can be installed by
+running
bundle install
@@ -23,22 +27,29 @@ To run a local web server, run
from the project's root directory.
You can then review your changes at http://localhost:4000/.
-Please note that the support for `--watch`ing for modification on Windows is kind of iffy at the moment of writing.
+Please note that the support for `--watch`ing for modification on Windows is
+kind of iffy at the moment of writing.
One possible workaround is to add `--force_polling` to `jekyll`s options:
bundle exec jekyll serve --watch --force_polling --config _config.yml,_config_dev.yml
-It might still not work though, so you might end up having to re-run `jekyll` manually.
+It might still not work though, so you might end up having to re-run `jekyll`
+manually.
For details, refer to http://jekyll-windows.juthilo.com/4-wdm-gem/.
-Note that `_config_dev.yml` is included to rewrite some of the `site` fields from `_config.yml` during development.
+Note that `_config_dev.yml` is included to rewrite some of the `site` fields
+from `_config.yml` during development.
In particular, it
-* sets `minified_externals` to `false` so that the properly formatted versions of external CSS stylesheets and JavaScript files are included instead of the `min`ified versions.
+* sets `minified_externals` to `false` so that the properly formatted versions
+ of external CSS stylesheets and JavaScript files are included instead of the
+ `min`ified versions.
## Licensing
-This project, including all of the files and their contents, is licensed under the terms of the MIT License.
-See LICENSE.txt for details.
+This project, including all of the files and their contents, is licensed under
+the terms of the MIT License.
+See [LICENSE.txt](LICENSE.txt) for details.
-This website is build upon the Twitter Bootstrap framework, which is also MIT Licensed and copyright 2015 Twitter.
+This website is build upon the Twitter Bootstrap framework, which is also MIT
+Licensed and copyright 2015 Twitter.