From bb7d901b03171225836b4d8d9dc958690c322e66 Mon Sep 17 00:00:00 2001 From: Maruan Al-Shedivat Date: Sat, 17 Jun 2017 01:11:46 -0700 Subject: [PATCH] Add Gemfile and installation instructions Addresses #4. --- Gemfile | 8 ++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 Gemfile diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..15c6846 --- /dev/null +++ b/Gemfile @@ -0,0 +1,8 @@ +source 'https://rubygems.org' +group :jekyll_plugins do + gem 'github-pages' + gem 'jekyll' + gem 'jekyll-paginate' + gem 'jekyll-scholar' + gem 'jemoji' +end diff --git a/README.md b/README.md index 1b32d4b..04e0897 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,24 @@ The emphasis is on whitespace, transparency, and academic usage: [theme demo](ht For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/). Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)! +### Installation + +Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first fork the theme from `github.com:alshedivat/al-folio` to `github.com:/` and do the following: + +```bash +$ git clone git@github.com:/.git +$ cd +$ bundle install +$ bundle exec jekyll serve +``` + +Now, feel free to customize the theme however you like (don't forget to change the name!). +After you are done, you can deploy it to [GitHub Pages](https://pages.github.com/) by running the deploy script: + +```bash +$ ./bin/deploy +``` + ## Features #### Ergonomic Publications