From f3252966fe4c267413ee37057e384ba4e8c7c8e1 Mon Sep 17 00:00:00 2001 From: czmj Date: Fri, 22 Sep 2017 11:21:53 +0100 Subject: [PATCH] README --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3a5405e..3a718cd 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,18 @@ -# Spectral - Jekyll Theme - -A Jekyll version of the "Spectral" theme by [HTML5 UP](https://html5up.net/). - -![Spectral Theme](screenshot.jpg "Spectral Theme") - # How to Use For those unfamiliar with how Jekyll works, check out [https://jekyllrb.com/](https://jekyllrb.com/) for all the details, or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/), and [creating pages](https://jekyllrb.com/docs/pages/). -- **GitLab**: Simply fork this repository and start editing the `_config.yml` file! -- **GitHub**: Fork this reposity and create a branch named `gh-pages`, then start editing the `_config.yml` file! The `.gitlab-ci.yml` file is only needed for GitLab Pages, so feel free to delete this if you are using GitHub instead. +# Quickstart -# Added Features +- Install Ruby if it's not already on your system -* Add your **social profiles** easily in `_config.yml`. Only social profiles buttons you enter in `config.yml` show up on the site footer! -* **Coming soon**: Set **featured images** in front matter. -* **Coming soon**: Front page sections automatically pull from posts. +``` +gem install jekyll bundler +jekyll serve +``` +- Edit `.md` files under `src` and `src/_posts`. # Credits