From 918aa5a8bd09a5c6ec0a8c498cc4ccbb120227d5 Mon Sep 17 00:00:00 2001 From: Shitong Luo Date: Sun, 21 Jul 2024 19:18:56 +0800 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5093c1a8..33022d59 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,37 @@ # academic-homepage -
- ![Preview](assets/images/etc/preview.png) [![pages-build-deployment](https://github.com/luost26/academic-homepage/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/luost26/academic-homepage/actions/workflows/pages/pages-build-deployment) [![W3C Validation](https://img.shields.io/w3c-validation/html?targetUrl=https%3A%2F%2Fluost26.github.io%2Facademic-homepage)](https://validator.nu/?doc=https%3A%2F%2Fluost26.github.io%2Facademic-homepage) [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fluost26%2Facademic-homepage&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) -
- ---- A GitHub Pages (Jekyll) template for personal academic website. Click [here](https://luost.me/academic-homepage/) to see the demo. +## Getting Started + +1. First, fork this repository or click the "Use this template" button to create a new repository. + - If you plan to customize the functionality or style of the template, and do not want to get updates from this repository, choose "Use this template". + - If you plan to only edit the content (biography, publications, news, etc.), and would like to get updates from this repository, choose "Fork". + - If you want to contribute to this project, fork the repository and submit a pull request. + +### Deploying to GitHub Pages + +2. Go to the repository settings and enable GitHub Pages. Detailed instructions can be found [here](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site). + +3. Navigate to your created website, and follow the instructions displayed on the homepage (if any) to finalize the setup. + +### Running Locally + +2. Follow the **step 1** and **step 2** of the instruction [here](https://jekyllrb.com/docs/) to install prerequisites and jekyll. + +3. Clone your forked repository to your local machine. + +4. Run the following command in the root directory of the repository: + + ```bash + bundle exec jekyll serve + ``` + +5. Browse to `http://localhost:4000/` to see the website.