From 34ea151e39c9fcd419c958ca8395be22512351c6 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Sat, 21 May 2016 02:24:32 +0300 Subject: README update --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9c78523..847643b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # 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 using [GitHub Pages] 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] is used to build a set of static HTML pages from a collection of +templates and resources. It might seem like Jekyll doesn't support Windows very well. However, at the moment of writing one can get it to work using the excellent tutorial at http://jekyll-windows.juthilo.com/. I personally had no problems running Jekyll on Windows whatsoever. -I use [Bundler](http://bundler.io/) to manage project's dependencies. +I use [Bundler] to manage project's dependencies. Make sure you have the `bundler` gem installed; project dependencies can then be installed by executing @@ -52,11 +51,18 @@ One easy workaround might be to `wget` the website and convert the links: wget --convert-links --recursive http://localhost:4000/ -## Licensing +## License This project, including all of the files and their contents, is licensed under the terms of the MIT License. -See LICENSE.txt for details. +See [LICENSE.txt] for details. This website is build upon the Twitter Bootstrap framework, which is also MIT Licensed and copyright 2015 Twitter. + + + +[LICENSE.txt]: LICENSE.txt +[GitHub Pages]: https://pages.github.com +[Jekyll]: https://jekyllrb.com/ +[Bundler]: http://bundler.io/ -- cgit v1.2.3