Skip to content

Commit f74517c

Browse files
authored
Update README.md (#25)
1 parent 95bece8 commit f74517c

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
# vLLM Blog Source
22

3-
How to compile the blogpost:
3+
How to compile the blogpost locally:
44

55
1. Install `jekyll` and `bundler` by running `gem install jekyll bundler`. Ask ChatGPT for help if you encounter any issues.
66
2. `bundle install` to install the necessary gems.
77
3. `rm ./Gemfile.lock` if you meet gem error.
8-
4. `bundle exec jekyll server` to compile and start the server.
8+
5. `bundle exec jekyll server` to compile and start the server.
99

1010
To add a new blogpost, please refer to `_posts/2023-06-20-vllm.md` as an example. Some notes:
1111
- Google Doc can be saved as markdown format which will make your life easier.
1212
- Note that the blogpost will only show when its date is in the past.
1313
- Put figures under `assets/figures/yourblogname/`.
14-
- Push your edits to this repo to save your changes.
14+
- Make a pull request.
1515

16-
To publish:
17-
- `JEKYLL_ENV=production bundle exec jekyll build` to compile the blogpost fresh.
18-
- After you finish writing, copy the whole content of `_site/` to `vllm-project.github.io` and push to the github repo.
19-
- Note that there is a `CNAME` file in the `vllm-project.github.io` that is not included in `_site/`. Please do not delete it.
16+
The blog is automatically built and deployed by GitHub Actions when `main` is pushed to.
2017

2118
---
2219
Please find the original README below.

0 commit comments

Comments
 (0)