Skip to content

Commit d1e0577

Browse files
author
liuzi
committed
update readme for my site
1 parent be5e749 commit d1e0577

File tree

1 file changed

+21
-30
lines changed

1 file changed

+21
-30
lines changed

README.md

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,34 @@
1-
# Chirpy Starter
1+
# [Liuzi's GitHub Pages Site](https://liuzi.github.io)
22

3-
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
4-
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
3+
Welcome to Liuzi's GitHub Pages site, powered by Jekyll and the Chirpy theme. This site is a collection of my learning notes, projects, and tutorials, with a focus on GenAI (e.g., LLMs, Diffusion Models, GAN, etc.) and its applications.
54

6-
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
7-
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file
8-
from the theme's gem. If you have ever installed this theme gem, you can use the command
9-
`bundle info --path jekyll-theme-chirpy` to locate these files.
5+
## About
106

11-
The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being
12-
able to enjoy the out-of-the-box experience when using feature-rich themes.
7+
This site is built using the [Chirpy theme-Starter Version](https://chirpy.cotes.page/posts/getting-started/#option-1-using-the-starter-recommended), which offers a clean and modern design, ideal for sharing content and ideas. The theme is highly customizable and extendable, making it an excellent choice for personal blogs and project showcases.
138

14-
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your
15-
Jekyll site. The following is a list of targets:
9+
Setting up the development environment is straightforward. You can use Dev Containers with Visual Studio Code or Cursor IDEs for a seamless experience. For Mac users, it's recommended to use [Colima](https://github.com/abiosoft/colima) to start the Docker daemon efficiently, ensuring a smooth workflow.
1610

17-
```shell
18-
.
19-
├── _config.yml
20-
├── _plugins
21-
├── _tabs
22-
└── index.html
23-
```
11+
Whether you're a beginner or an experienced developer, the Chirpy theme provides the tools you need to create a professional and engaging site.
2412

25-
To save you time, and also in case you lose some files while copying, we extract those files/configurations of the
26-
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.
13+
## Generative Models
2714

28-
## Usage
15+
One of the key topics I explore on this site is generative models. You can read more about this in my post: [Generative Models](https://liuzi.github.io/posts/generative-models/). This post covers the basics of generative modeling, including:
2916

30-
Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
17+
- The difference between discriminative and generative models
18+
- How generative models work
19+
- Applications of generative models in AI
3120

32-
## Contributing
21+
## Getting Started with Chirpy
3322

34-
This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the [theme repository][chirpy] to provide feedback.
23+
If you're interested in setting up your own site using the Chirpy theme, you can follow these steps:
3524

36-
## License
25+
1. **Create a Site Repository**: Use the Chirpy starter template to create a new repository on GitHub.
26+
2. **Set Up the Environment**: Follow the instructions to install Jekyll and set up your development environment.
27+
3. **Customize Your Site**: Modify the `_config.yml` file and other settings to personalize your site.
28+
4. **Deploy Your Site**: Use GitHub Actions or manually deploy your site to make it live.
3729

38-
This work is published under [MIT][mit] License.
30+
For detailed instructions, visit the [Chirpy Getting Started Guide](https://chirpy.cotes.page/posts/getting-started/).
3931

40-
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
41-
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
42-
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
43-
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE
32+
---
33+
34+
Thank you for visiting my site. I hope you find the content informative and engaging!

0 commit comments

Comments
 (0)