Skip to content

Commit 8aed043

Browse files
committed
added README
1 parent 79d6d09 commit 8aed043

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# whybhav.in
2+
3+
hi, this is the repo of my website.
4+
5+
as someone with multiple years of experience in various frontend js frameworks, i decided to built this with jekyll because why the heck not?
6+
7+
## the site has
8+
9+
- a minimalist design that i'll probably get bored of in a year (as is tradition)
10+
- a blog section with utterances comments
11+
- a photo gallery that makes me feel like i'm better at photography than i actually am
12+
- a "now" page that i'll update when i remember it exists
13+
- a responsive design that somehow works on both phones and computers?
14+
15+
## local setup
16+
17+
to to run this locally:
18+
19+
```bash
20+
# clone the repo
21+
git clone https://github.com/codebhav/codebhav.github.io.git
22+
23+
# go into the project
24+
cd codebhav.github.io
25+
26+
# install dependencies
27+
bundle install
28+
29+
# start the jekyll server
30+
bundle exec jekyll serve
31+
```
32+
33+
## photo processing
34+
35+
i hate the idea of having to create different versions of the same photo for optimization, so i wrote a dainty shell script that you can run. it creates a low-res version of any new images you add to `/assets/images/photos/fullsize` and also automatically populates the necessary markdown files
36+
37+
```bash
38+
chmod +x process_photos.sh
39+
./process_photos.sh
40+
```
41+
42+
note: you need to have ImageMagick installed.
43+
44+
## license
45+
46+
MIT licensed - see the LICENSE file for details.
47+
48+
## credits
49+
50+
special thanks to github.com/adryd325/oneko.js for making a handy js script for having a cat follow your cursor around, which is objectively the best feature of this website.

0 commit comments

Comments
 (0)