Skip to content

Commit

Permalink
Add Gemfile and installation instructions
Browse files Browse the repository at this point in the history
Addresses barryclark#4.
  • Loading branch information
alshedivat committed Jun 17, 2017
1 parent 40f39ef commit bb7d901
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<your-username>/<your-repo-name>` and do the following:

```bash
$ git clone [email protected]:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>
$ 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
Expand Down

0 comments on commit bb7d901

Please sign in to comment.