From 4e5c546629dbc3208251a686220eb8fb6f54201b Mon Sep 17 00:00:00 2001 From: Ayo Date: Mon, 20 Mar 2023 13:26:28 +0100 Subject: [PATCH] update readme --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c436cac..510f0cf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -This blog is built with Jekyll on top of the default [Minima theme](https://github.com/jekyll/minima). +This is the repo for [blog.ayco.io](https://blog.ayco.io), which is built with [Jekyll](https://jekyllrb.com) and heavily modified styling on top of the default [Minima theme](https://github.com/jekyll/minima). -[![Netlify Status](https://api.netlify.com/api/v1/badges/febbfcdf-6c88-414f-944a-ae0c7acca126/deploy-status)](https://app.netlify.com/sites/reverent-bohr-f2b261/deploys) +I add ideas, outline, or drafts as [github issues](https://github.com/ayoayco/blog/issues) first. You can file an issue too if you want to request a topic or get in touch about anything on the blog. +## How to Set Up the Project + +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 +``` + +3. install dependencies: +``` +bundle install +``` + +4. run dev server: +``` +bundle exec jekyll serve +``` + +5. build project: +``` +bundle exec jekyll build +```