From e6b807ee6fe508c800d58ceb0c01b4ba6eaf437c Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Fri, 30 Apr 2021 14:08:12 +0800 Subject: [PATCH] Update README to v4.0.0 --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 866b617..8157df5 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,20 @@ The startup template for [**Jekyll Theme Chirpy**][chirpy]. -When installing the Chirpy through [RubyGems][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem (use the command `bundle info --path jekyll-theme-chirpy` to locate). To fully use all the features of Chirpy, you also need to copy other critical files/directories from the theme's gem to your Jekyll site. +When installing the **Chirpy** theme through [RubyGems][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file from the theme's gem. (You can find the gem files by using the command `bundle info --path jekyll-theme-chirpy`). To fully use all the features of **Chirpy**, you need to copy the other critical files/directories from the theme's gem to your Jekyll site. + +The key files/directories to run/build the **Chirpy** theme are as follows: ```shell -# The critical files/directories to run Chirpy theme +. ├── _data ├── _plugins ├── _tabs ├── _config.yml -├── app.js -├── feed.xml -├── index.html -├── robots.txt -├── sw.js -└── 404.html +└── index.html ``` -We extracted all the necessary content of **Chirpy** theme's gem to help you quickly use the theme. +So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly. ## Installation