chore: update readme

This commit is contained in:
Ayo Ayco 2024-06-22 22:07:12 +02:00
parent ae1b07d554
commit 164064cf58

View file

@ -1,26 +1,26 @@
This is the repo for [ayos.blog](https://ayos.blog), which is built with [Jekyll](https://jekyllrb.com) and heavily modified styling on top of the default [Minima theme](https://github.com/jekyll/minima).
## How to Set Up the Project
## Project Setup
1. follow the [jekyll installation guide](https://jekyllrb.com/docs/installation) for your machine
2. clone project, then go to the directory:
```
git clone git@github.com:ayoayco/blog
cd blog
$ git clone git@github.com:ayoayco/blog
$ cd blog
```
3. install dependencies:
```
bundle install
$ bundle install
```
4. run dev server:
```
bundle exec jekyll serve --livereload
$ bundle exec jekyll serve --livereload
```
5. build project:
```
bundle exec jekyll build
$ bundle exec jekyll build
```