Skip to content

Commit c2a7480

Browse files
committed
Update README
1 parent 4abf09e commit c2a7480

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
# Chirpy Starter [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy) [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
22

3+
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][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. If you have ever installed this theme gem, you can use the command `bundle info --path jekyll-theme-chirpy` to locate these files.
34

4-
The startup template for [**Jekyll Theme Chirpy**][chirpy].
5+
The Jekyll organization claims that this is to leave the ball in the user’s court, but this also results in users not being able to enjoy the out-of-the-box experience when using feature-rich themes.
56

6-
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.
7-
8-
The critical files/directories to run or build the **Chirpy** theme are as follows:
7+
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your Jekyll site. The following is a list of targets:
98

109
```shell
1110
.
11+
├── _config.yml
1212
├── _data
1313
├── _plugins
1414
├── _tabs
15-
├── _config.yml
16-
└── index.html
15+
└── index.html
1716
```
1817

19-
So we've extracted all the **Chirpy** gem necessary content here to help you get started quickly.
18+
In order to save your time, and to prevent you from missing some files when copying, we extract those files/configurations of the latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.
19+
20+
## Prerequisites
21+
22+
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
2023

2124
## Installation
2225

23-
[Use this template][usetemplate] to generate a new repository, and then execute:
26+
[**Use this template**][use-template] to generate a brand new repository and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
2427

25-
[usetemplate]: https://github.com/cotes2020/chirpy-starter/generate
28+
Then clone it to your local machine and run:
2629

2730
```
2831
$ bundle
@@ -32,22 +35,12 @@ $ bundle
3235

3336
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#usage).
3437

35-
## Upgrading
36-
37-
First, please modify the target version number of `jekyll-theme-chirpy` in the `Gemfile` (e.g., `gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1"`).
38-
39-
After that, execute the following command:
40-
41-
```console
42-
$ bundle update jekyll-theme-chirpy
43-
```
44-
45-
As the version upgrades, the critical files and configuration options will change. Please refer to the [Upgrade Guide](https://github.com/cotes2020/jekyll-theme-chirpy/wiki/Upgrade-Guide) to keep your website files in sync with the latest version of the theme.
46-
4738
## License
4839

4940
This work is published under [MIT][mit] License.
5041

5142
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
5243
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
44+
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
45+
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
5346
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE

0 commit comments

Comments
 (0)