From f74517c7fe60199ee3721b3ffd174ddf83332928 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Fri, 7 Feb 2025 00:44:22 +0000 Subject: [PATCH] Update README.md (#25) --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 08b4af5..f155403 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,19 @@ # vLLM Blog Source -How to compile the blogpost: +How to compile the blogpost locally: 1. Install `jekyll` and `bundler` by running `gem install jekyll bundler`. Ask ChatGPT for help if you encounter any issues. 2. `bundle install` to install the necessary gems. 3. `rm ./Gemfile.lock` if you meet gem error. -4. `bundle exec jekyll server` to compile and start the server. +5. `bundle exec jekyll server` to compile and start the server. To add a new blogpost, please refer to `_posts/2023-06-20-vllm.md` as an example. Some notes: - Google Doc can be saved as markdown format which will make your life easier. - Note that the blogpost will only show when its date is in the past. - Put figures under `assets/figures/yourblogname/`. -- Push your edits to this repo to save your changes. +- Make a pull request. -To publish: -- `JEKYLL_ENV=production bundle exec jekyll build` to compile the blogpost fresh. -- After you finish writing, copy the whole content of `_site/` to `vllm-project.github.io` and push to the github repo. -- Note that there is a `CNAME` file in the `vllm-project.github.io` that is not included in `_site/`. Please do not delete it. +The blog is automatically built and deployed by GitHub Actions when `main` is pushed to. --- Please find the original README below.