Skip to content

Commit bb7d901

Browse files
committed
Add Gemfile and installation instructions
Addresses alshedivat#4.
1 parent 40f39ef commit bb7d901

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

Gemfile

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
source 'https://rubygems.org'
2+
group :jekyll_plugins do
3+
gem 'github-pages'
4+
gem 'jekyll'
5+
gem 'jekyll-paginate'
6+
gem 'jekyll-scholar'
7+
gem 'jemoji'
8+
end

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,24 @@ The emphasis is on whitespace, transparency, and academic usage: [theme demo](ht
1616
For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
1717
Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
1818

19+
### Installation
20+
21+
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:
22+
23+
```bash
24+
$ git clone git@github.com:<your-username>/<your-repo-name>.git
25+
$ cd <your-repo-name>
26+
$ bundle install
27+
$ bundle exec jekyll serve
28+
```
29+
30+
Now, feel free to customize the theme however you like (don't forget to change the name!).
31+
After you are done, you can deploy it to [GitHub Pages](https://pages.github.com/) by running the deploy script:
32+
33+
```bash
34+
$ ./bin/deploy
35+
```
36+
1937
## Features
2038

2139
#### Ergonomic Publications

0 commit comments

Comments
 (0)