Skip to content

Commit 66ade6a

Browse files
committed
Document how to run and update to latest theme version.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
1 parent a5eb60c commit 66ade6a

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

+49-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
## Checkout
22

3-
cd path/to/your/repos
4-
git clone git@github.com:kernelkit/kernelkit.github.io.git blog
5-
cd blog/
6-
git submodule update --init
3+
```bash
4+
cd path/to/your/repos
5+
git clone git@github.com:kernelkit/kernelkit.github.io.git blog
6+
cd blog/
7+
git submodule update --init
8+
```
79

810
Make changes/additions on a separate branch:
911

10-
git checkout -b my-changes
12+
```bash
13+
git checkout -b my-changes
14+
```
1115

1216
When you push it to GitHub you will get a question by GitHub.com if you
1317
want to create a pull request. Do that and follow the instructions.
@@ -21,6 +25,46 @@ Verified to work on Linux Mint 21.3, based on Ubuntu 22.04 LTS:
2125
- [Install Jekyll](https://jekyllrb.com/docs/installation/)
2226
- Run `bundle` from the blog directory to install all deps
2327

28+
29+
## Running
30+
31+
With everyting installed, starting the previewer is as simple as:
32+
33+
```bash
34+
$ jekyll serve
35+
Configuration file: /home/jocke/src/kernelkit.github.io/_config.yml
36+
Source: /home/jocke/src/kernelkit.github.io
37+
Destination: /home/jocke/src/kernelkit.github.io/_site
38+
Incremental build: disabled. Enable with --incremental
39+
Generating...
40+
done in 0.801 seconds.
41+
Auto-regeneration: enabled for '/home/jocke/src/kernelkit.github.io'
42+
Server address: http://127.0.0.1:4000/
43+
Server running... press ctrl-c to stop.
44+
```
45+
46+
## Updating
47+
48+
Occasionally we update the Chirpy theme or its dependencies. To be able
49+
to continue using the previewer, you need to update your deps:
50+
51+
```bash
52+
$ bundle update
53+
Fetching gem metadata from https://rubygems.org/...........
54+
Resolving dependencies...
55+
Fetching concurrent-ruby 1.3.4 (was 1.3.3)
56+
Fetching google-protobuf 4.27.4 (x86_64-linux) (was 4.27.2)
57+
Fetching rexml 3.3.6 (was 3.3.2)
58+
Fetching parallel 1.26.3 (was 1.25.1)
59+
Installing concurrent-ruby 1.3.4 (was 1.3.3)
60+
Installing google-protobuf 4.27.4 (x86_64-linux) (was 4.27.2)
61+
Installing rexml 3.3.6 (was 3.3.2)
62+
Fetching jekyll-theme-chirpy 7.1.0 (was 7.0.1)
63+
Installing parallel 1.26.3 (was 1.25.1)
64+
Installing jekyll-theme-chirpy 7.1.0 (was 7.0.1)
65+
Bundle updated!
66+
```
67+
2468
## Identity
2569

2670
All blog posts have one or more authors. Make sure your nick is added

0 commit comments

Comments
 (0)