From b04b34538198a73eed8ad3be680597be333cc30b Mon Sep 17 00:00:00 2001
From: Cotes Chung <11371340+cotes2020@users.noreply.github.com>
Date: Mon, 30 Sep 2019 20:37:14 +0800
Subject: [PATCH] Import README.

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b62625
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Jekyll Theme Chirpy
+
+[![Build Status](https://travis-ci.com/cotes2020/jekyll-theme-chirpy.svg?branch=master)](https://travis-ci.com/cotes2020/jekyll-theme-chirpy)
+[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE)
+[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
+
+![devices-mockup](assets/img/sample/devices-mockup.png)
+
+A Jekyll theme with responsive web design that focuses on text presentation. [Live Demo »](https://chirpy.cotes.info)
+
+## Features
+
+* Last modified date
+* Table of Contents
+* Disqus Comments
+* Syntax highlighting
+* Two Level Categories
+* Search
+* HTML compress
+* Atom feeds
+* Google Analytics
+* Pageviews (Advanced)
+
+## Quick start
+
+First of all, complete the installation of the following environment dependencies:
+
+- [Ruby](https://www.ruby-lang.org/en/downloads/)
+- [RubyGem](https://rubygems.org/pages/download)
+- [Bundler](https://bundler.io/)
+- [Jekyll](https://jekyllrb.com/)
+- [Python](https://www.python.org/downloads/) 
+- [ruamel.yaml](https://pypi.org/project/ruamel.yaml/)
+
+Clone the repository locally, but to prevent losing the latest features, consider using **Fork** instead of cloning. 
+
+Install the Jekyll plugins:
+
+```
+$ bundle install
+```
+
+Boot your site locally:
+
+```
+$ bash run.sh
+```
+
+Now, open your favorite brower and visit <http://127.0.0.1:4000>
+
+Please refer to the [documentation](https://chirpy.cotes.info/posts/getting-started/) for more details. Hope you like it.
+
+
+## License
+
+This work is published under [MIT](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) License.